org.apache.arrow.vector.ipc.message

Interface MessageReader

All Known Implementing Classes:

MessageChannelReader

public interface MessageReader

Interface for reading a sequence of messages.

Method Summary

Methods

Modifier and Type	Method and Description
long	bytesRead() Return the current number of bytes that have been read.
void	close() Close any resource opened by the message reader, not including message body allocations.
ArrowBuf	readMessageBody(Message message, BufferAllocator allocator) When a message is followed by a body of data, read that data into an ArrowBuf.
Message	readNextMessage() Read the next message in the sequence.

Method Detail

readNextMessage

Message readNextMessage()
                        throws IOException

Read the next message in the sequence.

Returns:

The read message or null if reached the end of the message sequence

Throws:

IOException

readMessageBody

ArrowBuf readMessageBody(Message message,
                       BufferAllocator allocator)
                         throws IOException

When a message is followed by a body of data, read that data into an ArrowBuf. This should only be called when a Message has a body length > 0.

Parameters:

message - Read message that is followed by a body of data

allocator - BufferAllocator to allocate memory for body data

Returns:

An ArrowBuf containing the body of the message that was read

Throws:

IOException

bytesRead

long bytesRead()

Return the current number of bytes that have been read.

Returns:

number of bytes read

close

void close()
           throws IOException

Close any resource opened by the message reader, not including message body allocations.

Throws:

IOException