firebird/firebird-mirror
firebird/firebird-mirror
8
0
Fork 1
mirror of https://github.com/FirebirdSQL/firebird.git synced 2025-01-22 20:43:02 +01:00
Code Issues

Docs for #7951: Make it possible to handle attach errors in key holder plugin.

Browse Source
This commit is contained in:
AlexPeshkoff 2024-01-11 14:31:02 +03:00
parent c2238907a7
commit 3912346e6f
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/Using_OO_API.html
View File

@ -2308,7 +2308,7 @@ interface – main interface from which start all operations with
firebird API.</font></p> firebird API.</font></p>
<ol> <ol>
<li><p style="margin-bottom: 0cm"><font size="4" style="font-size: 14pt">IStatus* <li><p style="margin-bottom: 0cm"><font size="4" style="font-size: 14pt">IStatus*
getStatus() - get instance if <a href="#Status">Status</a> getStatus() - get instance of <a href="#Status">Status</a>
interface.</font></p> interface.</font></p>
<li><p style="margin-bottom: 0cm"><font size="4" style="font-size: 14pt">IProvider* <li><p style="margin-bottom: 0cm"><font size="4" style="font-size: 14pt">IProvider*
getDispatcher() - get instance of <a href="#Provider">Provider</a> getDispatcher() - get instance of <a href="#Provider">Provider</a>
@ -3615,6 +3615,20 @@ plugin or key holder plugin.</font></p>
is passed in both directions. The source of a key receives is passed in both directions. The source of a key receives
dataLength bytes of data and may send up to bufferLength bytes into dataLength bytes of data and may send up to bufferLength bytes into
buffer returning actual number of bytes placed into buffer.</font></p> buffer returning actual number of bytes placed into buffer.</font></p>
<li><p style="margin-bottom: 0cm"><font size="4" style="font-size: 14pt">
void dispose() - invoked when interface is not needed any more. Helps
to avoid memory leaks in statefull inrefaces.
</font></p>
<li><p style="margin-bottom: 0cm"><font size="4" style="font-size: 14pt">
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:
<p style="margin-bottom: 0cm"><font size="4" style="font-size: 14pt">NO_RETRY -
do not repeat attempts to attach to database.</font></p>
<p style="margin-bottom: 0cm"><font size="4" style="font-size: 14pt">DO_RETRY -
retry attach (ignored when function was called without attStatus).</font></p>
</font></p>
</ol> </ol>
<p style="margin-bottom: 0cm"><br/> <p style="margin-bottom: 0cm"><br/>