com.vertica.sdk.UDXObject Class Reference

Inheritance diagram for com.vertica.sdk.UDXObject:

Collaboration diagram for com.vertica.sdk.UDXObject:

Public Member Functions
final void cancelUDX (ServerInterface srvInterface)
boolean isCanceled ()
Protected Member Functions
void cancel (ServerInterface srvInterface)

Detailed Description

Base class for Vertica User-Defined extensions (the function classes themselves). Not intended for direct use by applications.

Member Function Documentation

void com.vertica.sdk.UDXObject.cancel(ServerInterface srvInterface)

protected

Cancel callback to be overridden by the UDX implementation. Called when the query running the UDX has been canceled.

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

final void com.vertica.sdk.UDXObject.cancelUDX(ServerInterface srvInterface)

Cancel callback invoked when the query running the UDX has been canceled.

See cancel().

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
boolean com.vertica.sdk.UDXObject.isCanceled()

Returns true if execution was canceled.

Referenced by com.vertica.sdk.UDXObject.cancelUDX().