org.bytedeco.arrow

Class MessageDecoderListener

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.MessageDecoderListener

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

AssignMessageDecoderListener

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

\class MessageDecoderListener \brief An abstract class to listen events from MessageDecoder. This API is EXPERIMENTAL.

Since:

0.17.0

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
MessageDecoderListener(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Status	OnBody() \brief Called when the decoder state is changed to MessageDecoder::State::BODY.
Status	OnEOS() \brief Called when the decoder state is changed to MessageDecoder::State::EOS.
Status	OnInitial() \brief Called when the decoder state is changed to MessageDecoder::State::INITIAL.
Status	OnMessageDecoded(Message message) \brief Called when a message is decoded.
Status	OnMetadata() \brief Called when the decoder state is changed to MessageDecoder::State::METADATA.
Status	OnMetadataLength() \brief Called when the decoder state is changed to MessageDecoder::State::METADATA_LENGTH.

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

MessageDecoderListener

public MessageDecoderListener(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

OnMessageDecoded

@ByVal
public Status OnMessageDecoded(@UniquePtr
                                      Message message)

\brief Called when a message is decoded. MessageDecoder calls this method when it decodes a message. This method is called multiple times when the target stream has multiple messages.

Parameters:

message - [in] a decoded message

Returns:

Status

OnInitial

@ByVal
public Status OnInitial()

\brief Called when the decoder state is changed to MessageDecoder::State::INITIAL. The default implementation just returns arrow::Status::OK().

Returns:

Status

OnMetadataLength

@ByVal
public Status OnMetadataLength()

\brief Called when the decoder state is changed to MessageDecoder::State::METADATA_LENGTH. The default implementation just returns arrow::Status::OK().

Returns:

Status

OnMetadata

@ByVal
public Status OnMetadata()

\brief Called when the decoder state is changed to MessageDecoder::State::METADATA. The default implementation just returns arrow::Status::OK().

Returns:

Status

OnBody

@ByVal
public Status OnBody()

\brief Called when the decoder state is changed to MessageDecoder::State::BODY. The default implementation just returns arrow::Status::OK().

Returns:

Status

OnEOS

@ByVal
public Status OnEOS()

\brief Called when the decoder state is changed to MessageDecoder::State::EOS. The default implementation just returns arrow::Status::OK().

Returns:

Status