omero::cmd::Handle

Overview

[ "ami" ] interface Handle

Operation Index

addCallback: Add a callback for notifications.
removeCallback: Remove callback for notifications.
getRequest: Returns the request object that was used to initialize this handle.
getResponse: Returns a response if this handle has finished execution, otherwise returns null.
getStatus: Returns a status object for the current execution.
cancel: Attempts to cancel execution of this Request.
close: Closes this handle.

Operations

void addCallback(CmdCallback* cb)

Add a callback for notifications.

void removeCallback(CmdCallback* cb)

Remove callback for notifications.

Request getRequest()

Returns the request object that was used to initialize this handle. Never null.

Response getResponse()

Returns a response if this handle has finished execution, otherwise returns null.

Status getStatus()

Returns a status object for the current execution. This will likely be the same object that would be returned as a component of the Response value. Never null.

bool cancel() throws LockTimeout

Attempts to cancel execution of this Request. Returns true if cancellation was successful. Returns false if not, in which case likely this request will run to completion.

void close()

Closes this handle. If the request is running, then a cancellation will be attempted first. All uses of a handle should be surrounded by a try/finally close block.

Home

Index