org.bytedeco.arrow

Class Message

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.Message

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow::ipc")
 @NoOffset
 @Properties(inherit=arrow.class)
public class Message
extends Pointer

\class Message \brief An IPC message including metadata and body

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
Message(ArrowBuffer metadata, ArrowBuffer body) \brief Construct message, but do not validate Use at your own risk; Message::Open has more metadata validation
Message(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
long	body_length() \brief The expected body length according to the metadata, for verification purposes
ArrowBuffer	body() \brief the Message body, if any
KeyValueMetadata	custom_metadata() \brief Custom metadata serialized in metadata Flatbuffer.
boolean	Equals(Message other) \brief Return true if message type and contents are equal
static boolean	HasBody(arrow.MessageType type) \brief Whether a given message type needs a body.
static boolean	HasBody(int type)
Pointer	header()
arrow.MetadataVersion	metadata_version() \brief The Message metadata version
ArrowBuffer	metadata() \brief the Message metadata
static MessageUniqueResult	Open(ArrowBuffer metadata, ArrowBuffer body) \brief Create and validate a Message instance from two buffers
static MessageUniqueResult	ReadFrom(ArrowBuffer metadata, InputStream stream) \brief Read message body and create Message given Flatbuffer metadata
static MessageUniqueResult	ReadFrom(long offset, ArrowBuffer metadata, RandomAccessFile file) \brief Read message body from position in file, and create Message given the Flatbuffer metadata
Status	SerializeTo(OutputStream file, IpcWriteOptions options, long[] output_length)
Status	SerializeTo(OutputStream file, IpcWriteOptions options, LongBuffer output_length)
Status	SerializeTo(OutputStream file, IpcWriteOptions options, LongPointer output_length) \brief Write length-prefixed metadata and body to output stream
arrow.MessageType	type() \brief The Message type
boolean	Verify() \brief Return true if the Message metadata passes Flatbuffer validation

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Message

public Message(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Message

public Message(@SharedPtr
               ArrowBuffer metadata,
               @SharedPtr
               ArrowBuffer body)

\brief Construct message, but do not validate Use at your own risk; Message::Open has more metadata validation

Method Detail

Open

@ByVal
public static MessageUniqueResult Open(@SharedPtr
                                              ArrowBuffer metadata,
                                              @SharedPtr
                                              ArrowBuffer body)

\brief Create and validate a Message instance from two buffers

Parameters:

metadata - [in] a buffer containing the Flatbuffer metadata

body - [in] a buffer containing the message body, which may be null

Returns:

the created message

ReadFrom

@ByVal
public static MessageUniqueResult ReadFrom(@SharedPtr
                                                  ArrowBuffer metadata,
                                                  InputStream stream)

\brief Read message body and create Message given Flatbuffer metadata

Parameters:

metadata - [in] containing a serialized Message flatbuffer

stream - [in] an InputStream

Returns:

the created Message \note If stream supports zero-copy, this is zero-copy

ReadFrom

@ByVal
public static MessageUniqueResult ReadFrom(@Cast(value="const int64_t")
                                                  long offset,
                                                  @SharedPtr
                                                  ArrowBuffer metadata,
                                                  RandomAccessFile file)

\brief Read message body from position in file, and create Message given the Flatbuffer metadata

Parameters:

offset - [in] the position in the file where the message body starts.

metadata - [in] containing a serialized Message flatbuffer

file - [in] the seekable file interface to read from

Returns:

the created Message \note If file supports zero-copy, this is zero-copy

Equals

@Cast(value="bool")
public boolean Equals(@Const @ByRef
                                          Message other)

\brief Return true if message type and contents are equal

Parameters:

other - another message

Returns:

true if contents equal

metadata

@SharedPtr
public ArrowBuffer metadata()

\brief the Message metadata

Returns:

buffer

custom_metadata

@SharedPtr
 @Cast(value={"const arrow::KeyValueMetadata*","std::shared_ptr<const arrow::KeyValueMetadata>"})
public KeyValueMetadata custom_metadata()

\brief Custom metadata serialized in metadata Flatbuffer. Returns nullptr when none set

body

@SharedPtr
public ArrowBuffer body()

\brief the Message body, if any

Returns:

buffer is null if no body

body_length

@Cast(value="int64_t")
public long body_length()

\brief The expected body length according to the metadata, for verification purposes

type

public arrow.MessageType type()

\brief The Message type

metadata_version

public arrow.MetadataVersion metadata_version()

\brief The Message metadata version

header

@Const
public Pointer header()

SerializeTo

@ByVal
public Status SerializeTo(OutputStream file,
                                 @Const @ByRef
                                 IpcWriteOptions options,
                                 @Cast(value="int64_t*")
                                 LongPointer output_length)

\brief Write length-prefixed metadata and body to output stream

Parameters:

file - [in] output stream to write to

options - [in] IPC writing options including alignment

output_length - [out] the number of bytes written

Returns:

Status

SerializeTo

@ByVal
public Status SerializeTo(OutputStream file,
                                 @Const @ByRef
                                 IpcWriteOptions options,
                                 @Cast(value="int64_t*")
                                 LongBuffer output_length)

SerializeTo

@ByVal
public Status SerializeTo(OutputStream file,
                                 @Const @ByRef
                                 IpcWriteOptions options,
                                 @Cast(value="int64_t*")
                                 long[] output_length)

Verify

@Cast(value="bool")
public boolean Verify()

\brief Return true if the Message metadata passes Flatbuffer validation

HasBody

@Cast(value="bool")
public static boolean HasBody(arrow.MessageType type)

\brief Whether a given message type needs a body.

HasBody

@Cast(value="bool")
public static boolean HasBody(@Cast(value="arrow::ipc::MessageType")
                                                  int type)