io.picodata.driver.protocol

Class TarantoolRequest

java.lang.Object

io.picodata.driver.protocol.TarantoolRequest

Direct Known Subclasses:

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

public abstract 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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	TarantoolRequest.Builder<B extends TarantoolRequest.Builder<B>> Base class for request builder implementations

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
TarantoolRequestBody	getBody() Get body
TarantoolHeader	getHeader() Get header
Optional<TarantoolRequestSignature>	getSignature() Get signature
void	toMessagePack(org.msgpack.core.MessagePacker packer, MessagePackObjectMapper mapper) Encode incapsulated data using MessagePacker
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TarantoolRequest

public TarantoolRequest(TarantoolRequestType type,
                        TarantoolRequestBody body,
                        TarantoolRequestSignature signature)

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

signature - request signature, may be null

See Also:

TarantoolRequestType

Method Detail

getHeader

public TarantoolHeader getHeader()

Get header

Returns:

header instance

getBody

public TarantoolRequestBody getBody()

Get body

Returns:

instance of a Packable

getSignature

public Optional<TarantoolRequestSignature> getSignature()

Get signature

Returns:

request signature that uniquely represents the operation and argument types

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

toString

public String toString()

Overrides:

toString in class Object