Package io.tarantool.driver.protocol

Class TarantoolHeader

java.lang.Object

io.tarantool.driver.protocol.TarantoolHeader

All Implemented Interfaces:

Packable, Serializable

public final class TarantoolHeader
extends Object
implements Packable

Represents the Tarantool packet frame header. See https://www.tarantool.io/en/doc/2.3/dev_guide/internals/box_protocol/#box-protocol-header

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
static TarantoolHeader	fromMessagePackValue(org.msgpack.value.Value value)	Creates an instance of TarantoolHeader from MessagePack Value
Long	getSync()
org.msgpack.value.Value	toMessagePackValue(MessagePackObjectMapper mapper)	Converts the current header contents into a MessagePack Value

Methods inherited from class java.lang.Object

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

Method Detail

getSync

public Long getSync()

toMessagePackValue

public org.msgpack.value.Value toMessagePackValue(MessagePackObjectMapper mapper)

Converts the current header contents into a MessagePack Value

Specified by:

toMessagePackValue in interface Packable

Parameters:

mapper - configured Java objects to entities mapper

Returns:

MessagePack representation of the header

fromMessagePackValue

public static TarantoolHeader fromMessagePackValue(org.msgpack.value.Value value)
                                            throws TarantoolProtocolException

Creates an instance of TarantoolHeader from MessagePack Value

Parameters:

value - must be an instance of MapValue

Returns:

a TarantoolHeader instance

Throws:

TarantoolProtocolException - if the passed value is not a MapValue, mandatory fields are absent or have wrong type