Submitted by: Roman Rokytskyy (rrokytskyy)

Assigned to: Roman Rokytskyy (rrokytskyy)

New fb_cancel_operation() API call, allowing cancellation of the current activity being performed by some kind
of blocking API call in the given connection.

Syntax
ISC_STATUS fb_cancel_operation(ISC_STATUS* status_vector, isc_db_handle* db_handle, ISC_USHORT option);

Parameters

status vector (ISC_STATUS* status_vector) - A regular status vector pointer structure.

db_handle (pointer to a isc_db_handle) - A regular, valid database handle. It identifies the attachment.

option (unsigned short: symbol) - Determines the action to be performed. The option symbols are:
• fb_cancel_raise: cancels any activity related to the db_handle specified in the second parameter. The
effect will be that, as soon as possible, the engine will try to stop the running request and return an
exception to the caller via the status vector (parameter 1).
"..as soon as possible" will be, under normal conditions, at the next rescheduling point.
• fb_cancel_disable: disables execution of fb_cancel_raise requests for the specified attachment. It can be
useful when your program is executing critical operations, such as cleanup, for example.
• fb_cancel_enable: re-enables delivery of a cancel execution that was previously disabled. The 'cancel'
state is effective by default, being initialized when the attachment is created.
• fb_cancel_abort: : forcibly close client side of connection. Useful if you need to close a connection urgently.
All active transactions will be rolled back by the server. 'Success' is always returned to the application.
Use with care !