Aborting long operations

Detailed Description

OcilibCApiUserTypes

The Oracle OCI provides the ability to establish a server connection in:

• Blocking mode: each call to an OCI function returns control to the application when the call completes.
• Non-blocking mode (based on polling paradigm): the application has to call each function until it has completed its job.

OCILIB implements OCI in blocking mode. The application has to wait for OCI calls to complete to continue.

Some operations can take a long time to be processed by the server.

In order to cancel the current pending call, OCILIB provides OCI_Break() that cancels the last internal OCI call and then raises an OCI abortion error code.

Note

Any call to OCI_Break() has to be done from a separate thread because the thread that has executed a long OCI call is waiting for its OCI call to complete.

Example

#include "ocilib.h"
 
#if defined(_WINDOWS)
    #define sleep(x) Sleep(x*1000)
#else
    #include <unistd.h>
#endif
 
void long_oracle_call(OCI_Thread *thread, void *data)
{
    clock_t t_start = clock();
    int err_code = 0;
 
    if (!OCI_ExecuteStmt((OCI_Statement *)data, "begin dbms_lock.sleep(10); end;"))
    {
        OCI_Error *err = OCI_GetLastError();
        if (err)
        {
            err_code = OCI_ErrorGetOCICode(err);
        }
    }
    
    printf("call duration %d, expected oracle error is 1013, got %d", clock() - t_start, err_code);
}
 
 
int main(void)
{
    OCI_Connection *cn;
    OCI_Statement *st;
    OCI_Thread *th;
 
    if (!OCI_Initialize(NULL, NULL, OCI_ENV_THREADED | OCI_ENV_CONTEXT))
    {
        return EXIT_FAILURE;
    }
 
    th = OCI_ThreadCreate();
    cn = OCI_ConnectionCreate("db", "usr", "pwd", OCI_SESSION_DEFAULT);
    st = OCI_StatementCreate(cn);
 
    OCI_ThreadRun(th, long_oracle_call, st);
 
    sleep(1);
    OCI_Break(cn);
 
    OCI_ThreadJoin(th);
    OCI_ThreadFree(th);
 
    OCI_StatementFree(st);
    OCI_ConnectionFree(cn);
    OCI_Cleanup();
 
    return EXIT_SUCCESS;
}

Functions
OCI_SYM_PUBLIC boolean OCI_API	OCI_Break (OCI_Connection *con)
	Perform an immediate abort of any currently Oracle OCI call.

Function Documentation

OCI_Break()

OCI_SYM_PUBLIC boolean OCI_API OCI_Break

(

OCI_Connection *

con

)

#include <api.h>

Perform an immediate abort of any currently Oracle OCI call.

Parameters

con	- Connection handle

Note

The current call will abort and generate an error.

Returns

TRUE on success, or FALSE if the connection handle is NULL.

Referenced by ocilib::Connection::Break().