org.voltdb.client

Interface ClientResponse

public interface ClientResponse

Interface implemented by the responses that are generated for procedure invocations

Field Summary

Fields

Modifier and Type	Field and Description
static byte	CONNECTION_LOST Status code indicating the connection to the database that the invocation was queued at was lost before a response was received.
static byte	CONNECTION_TIMEOUT Status code indicating that the request didn't receive a response before the per-client timeout.
static byte	GRACEFUL_FAILURE Status code indicating the stored procedure failed and was rolled back.
static byte	OPERATIONAL_FAILURE Status code indicating that the transaction completed and did not roll back, but some part of the operation didn't succeed.
static byte	RESPONSE_UNKNOWN Status code indicating that the response was lost, and the outcome of the invocation is unknown.
static byte	SERVER_UNAVAILABLE Status code indicating that the server is currently unavailable for stored procedure invocations.
static byte	SUCCESS Status code indicating the store procedure executed successfully
static byte	TXN_MISPARTITIONED Status code indicating that the transaction was sent to the wrong partition.
static byte	TXN_MISROUTED Status code indicating that the transaction is mis-routed.
static byte	TXN_RESTART Status code indicating that the transaction is being restarted.
static byte	UNEXPECTED_FAILURE Status code indicating the stored procedure failed (or may never have been successfully invoked) and that there may have been negative side effects on the server
static byte	UNINITIALIZED_APP_STATUS_CODE Default value for the user specified app status code field
static byte	USER_ABORT Status code indicating the stored procedure executed successfully and was voluntarily aborted and rolled back by the stored procedure code

Method Summary

Modifier and Type	Method and Description
byte	getAppStatus() Retrieve the status code returned by the stored procedure.
java.lang.String	getAppStatusString() Get a String representation of any additional information the stored procedure may have included in the response.
int	getClientRoundtrip() Get the amount of time it took to run the transaction through the Client API, database, and back to the callback.
long	getClientRoundtripNanos() Get the amount of time it took to run the transaction through the Client API, database, and back to the callback.
int	getClusterRoundtrip() Get an estimate of the amount of time it took for the database to process the transaction from the time it was received at the initiating node to the time the initiating node got the response and queued it for transmission to the client.
VoltTable[]	getResults() Get the array of VoltTable results returned by the stored procedure.
byte	getStatus() Retrieve the status code returned by the server
java.lang.String	getStatusString() Get a String representation of any additional information the server may have included in the response.

Field Detail

SUCCESS

static final byte SUCCESS

Status code indicating the store procedure executed successfully

See Also:

Constant Field Values

USER_ABORT

static final byte USER_ABORT

Status code indicating the stored procedure executed successfully and was voluntarily aborted and rolled back by the stored procedure code

See Also:

Constant Field Values

GRACEFUL_FAILURE

static final byte GRACEFUL_FAILURE

Status code indicating the stored procedure failed and was rolled back. There are no negative server side side effects.

See Also:

Constant Field Values

UNEXPECTED_FAILURE

static final byte UNEXPECTED_FAILURE

Status code indicating the stored procedure failed (or may never have been successfully invoked) and that there may have been negative side effects on the server

See Also:

Constant Field Values

CONNECTION_LOST

static final byte CONNECTION_LOST

Status code indicating the connection to the database that the invocation was queued at was lost before a response was received. It is possible that the invocation was sent, executed, and successfully committed before a response could be returned or the invocation may never have been sent.

See Also:

Constant Field Values

SERVER_UNAVAILABLE

static final byte SERVER_UNAVAILABLE

Status code indicating that the server is currently unavailable for stored procedure invocations. The invocation for which this is a response was never executed.

See Also:

Constant Field Values

CONNECTION_TIMEOUT

static final byte CONNECTION_TIMEOUT

Status code indicating that the request didn't receive a response before the per-client timeout.

See Also:

Constant Field Values

RESPONSE_UNKNOWN

static final byte RESPONSE_UNKNOWN

Status code indicating that the response was lost, and the outcome of the invocation is unknown.

See Also:

Constant Field Values

TXN_RESTART

static final byte TXN_RESTART

Status code indicating that the transaction is being restarted. These are used internally to Volt and shouldn't leak out to actual clients.

See Also:

Constant Field Values

OPERATIONAL_FAILURE

static final byte OPERATIONAL_FAILURE

Status code indicating that the transaction completed and did not roll back, but some part of the operation didn't succeed. For example, this is returned when a snapshot restore operation fails to restore one table out of many.

See Also:

Constant Field Values

TXN_MISPARTITIONED

static final byte TXN_MISPARTITIONED

Status code indicating that the transaction was sent to the wrong partition. These are used internally to Volt and shouldn't leak out to actual clients.

See Also:

Constant Field Values

TXN_MISROUTED

static final byte TXN_MISROUTED

Status code indicating that the transaction is mis-routed. The transaction will be restarted. Used in the SPI leader balance case.

See Also:

Constant Field Values

UNINITIALIZED_APP_STATUS_CODE

static final byte UNINITIALIZED_APP_STATUS_CODE

Default value for the user specified app status code field

See Also:

Constant Field Values

Method Detail

getStatus

byte getStatus()

Retrieve the status code returned by the server

Returns:

Status code

getAppStatus

byte getAppStatus()

Retrieve the status code returned by the stored procedure. This code is generated by the application and not VoltDB. The default value is -128.

Returns:

Status code

getResults

VoltTable[] getResults()

Get the array of VoltTable results returned by the stored procedure.

Returns:

An array of results. Will never be null, but may be length 0.

getStatusString

java.lang.String getStatusString()

Get a String representation of any additional information the server may have included in the response. This may be an stack trace, error message, etc.

Returns:

A message or null if there is none.

getAppStatusString

java.lang.String getAppStatusString()

Get a String representation of any additional information the stored procedure may have included in the response. This may be an stack trace, error message, etc. This is generated by the application and not VoltDB. The default value is null.

Returns:

A message or null if there is none.

getClusterRoundtrip

int getClusterRoundtrip()

Get an estimate of the amount of time it took for the database to process the transaction from the time it was received at the initiating node to the time the initiating node got the response and queued it for transmission to the client. This time is an ESTIMATE

Returns:

Time in milliseconds the procedure spent in the cluster

getClientRoundtrip

int getClientRoundtrip()

Get the amount of time it took to run the transaction through the Client API, database, and back to the callback.

Returns:

Time in milliseconds the procedure took to roundtrip from the client to the server

getClientRoundtripNanos

long getClientRoundtripNanos()

Get the amount of time it took to run the transaction through the Client API, database, and back to the callback.

Returns:

Time in nanoseconds the procedure took to roundtrip from the client to the server