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

Inheritance diagram for Vertica::UDXObject:

Collaboration diagram for Vertica::UDXObject:

Public Member Functions
virtual	~UDXObject () noexcept(false)

void	cancelUDX (ServerInterface &srvInterface)

bool	isCanceled () const

Protected Member Functions
virtual void	cancel (ServerInterface &srvInterface)

Detailed Description

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

Constructor & Destructor Documentation

virtual Vertica::UDXObject::~UDXObject ( )

inlinevirtualnoexcept

Destructors MAY NOT throw errors / exceptions. Exceptions thrown during the destructor will be ignored.

virtual void Vertica::UDXObject::cancel ( ServerInterface & srvInterface )

inlineprotectedvirtual

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

Note

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 or destructor). 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.

void Vertica::UDXObject::cancelUDX ( ServerInterface & srvInterface )

inline

Cancel callback invoked when the query running the UDX has been canceled. See cancel().

bool Vertica::UDXObject::isCanceled ( ) const

inline