From 3912346e6fcee5f2b4cfed71815cbca0e1a21a79 Mon Sep 17 00:00:00 2001 From: AlexPeshkoff Date: Thu, 11 Jan 2024 14:31:02 +0300 Subject: [PATCH] Docs for #7951: Make it possible to handle attach errors in key holder plugin. --- doc/Using_OO_API.html | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/doc/Using_OO_API.html b/doc/Using_OO_API.html index 2c12cc68c8..ee7c3e1710 100644 --- a/doc/Using_OO_API.html +++ b/doc/Using_OO_API.html @@ -2308,7 +2308,7 @@ interface – main interface from which start all operations with firebird API.

  1. IStatus* - getStatus() - get instance if Status + getStatus() - get instance of Status interface.

  2. IProvider* getDispatcher() - get instance of Provider @@ -3615,6 +3615,20 @@ plugin or key holder plugin.

    is passed in both directions. The source of a key receives dataLength bytes of data and may send up to bufferLength bytes into buffer returning actual number of bytes placed into buffer.

    +

  3. + void dispose() - invoked when interface is not needed any more. Helps + to avoid memory leaks in statefull inrefaces. +

    +

  4. + unsigned afterAttach(StatusType* status, const char* dbName, const IStatus* attStatus) - + invoked after attach on client system. NULL in attStatus means attach was successful + but afterAttach() is anyway invoked in order to let plugin perform required cleanup. + The following values may be returned by this function: +

    NO_RETRY - + do not repeat attempts to attach to database.

    +

    DO_RETRY - + retry attach (ignored when function was called without attStatus).

    +