Package io.tarantool.driver.protocol

Class TarantoolRequest

java.lang.Object

io.tarantool.driver.protocol.TarantoolRequest

Direct Known Subclasses:

TarantoolAuthRequest, TarantoolCallRequest, TarantoolDeleteRequest, TarantoolEvalRequest, TarantoolInsertRequest, TarantoolReplaceRequest, TarantoolSelectRequest, TarantoolUpdateRequest, TarantoolUpsertRequest

public class TarantoolRequest
extends Object

Base class for all kinds of requests to Tarantool server. See https://www.tarantool.io/en/doc/2.3/dev_guide/internals/box_protocol/#binary-protocol-requests

Constructor Summary

Constructors

Constructor	Description
TarantoolRequest(TarantoolRequestType type, TarantoolRequestBody body)	Basic constructor.

Method Summary

Modifier and Type	Method	Description
Packable	getBody()	Get body
TarantoolHeader	getHeader()	Get header
void	toMessagePack(org.msgpack.core.MessagePacker packer, MessagePackObjectMapper mapper)	Encode incapsulated data using MessagePacker

Methods inherited from class java.lang.Object

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

Constructor Detail

TarantoolRequest

public TarantoolRequest(TarantoolRequestType type,
                        TarantoolRequestBody body)

Basic constructor. Sets an auto-incremented request ID into the Tarantool packet header.

Parameters:

type - request type code supported by Tarantool

body - request body, may be empty

See Also:

TarantoolRequestType

Method Detail

getHeader

public TarantoolHeader getHeader()

Get header

Returns:

header instance

getBody

public Packable getBody()

Get body

Returns:

instance of a Packable

toMessagePack

public void toMessagePack(org.msgpack.core.MessagePacker packer,
                          MessagePackObjectMapper mapper)
                   throws TarantoolDecoderException

Encode incapsulated data using MessagePacker

Parameters:

packer - configured MessagePacker

mapper - object-to-entity mapper

Throws:

TarantoolDecoderException - if encoding failed