io.picodata.driver.protocol

Class TarantoolResponse

java.lang.Object

io.picodata.driver.protocol.TarantoolResponse

public final class TarantoolResponse
extends Object

Base class for all kinds of responses received from Tarantool server.

See https://www.tarantool.io/en/doc/latest/dev_guide/internals/box_protocol/#binary-protocol-responses-if-no-error-and -no-sql

Method Summary

Modifier and Type	Method and Description
static TarantoolResponse	fromMessagePack(org.msgpack.core.MessageUnpacker unpacker) Create Tarantool response from the decoded binary data using MessageUnpacker
TarantoolResponseBody	getBody() Get response body
Long	getResponseCode() Get response code
TarantoolResponseType	getResponseType() Get response type
Long	getSyncId() Get request ID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSyncId

public Long getSyncId()

Get request ID

Returns:

a number

getBody

public TarantoolResponseBody getBody()

Get response body

Returns:

a MessagePack entity

See Also:

Value

getResponseType

public TarantoolResponseType getResponseType()

Get response type

Returns:

code of TarantoolRequestType type

getResponseCode

public Long getResponseCode()

Get response code

Returns:

a number, equal to 0 in case of OK response

See Also:

TarantoolResponseType

fromMessagePack

public static TarantoolResponse fromMessagePack(org.msgpack.core.MessageUnpacker unpacker)
                                         throws TarantoolProtocolException

Create Tarantool response from the decoded binary data using MessageUnpacker

Parameters:

unpacker - configured MessageUnpacker

Returns:

Tarantool response populated from the decoded binary data

Throws:

TarantoolProtocolException - if the unpacked data is invalid