Package org.apache.thrift.transport

Class TByteBuffer

java.lang.Object

org.apache.thrift.transport.TTransport

org.apache.thrift.transport.TEndpointTransport

org.apache.thrift.transport.TByteBuffer

All Implemented Interfaces:

Closeable, AutoCloseable

public final class TByteBuffer
extends TEndpointTransport

ByteBuffer-backed implementation of TTransport.

Field Summary

Fields inherited from class org.apache.thrift.transport.TEndpointTransport

knownMessageSize, remainingMessageSize

Constructor Summary

Constructors

Constructor	Description
TByteBuffer(ByteBuffer byteBuffer)	Creates a new TByteBuffer wrapping a given NIO ByteBuffer.
TByteBuffer(TConfiguration configuration, ByteBuffer byteBuffer)	Creates a new TByteBuffer wrapping a given NIO ByteBuffer and custom TConfiguration.

Method Summary

Modifier and Type	Method	Description
TByteBuffer	clear()	Convenience method to call clear() on the underlying NIO ByteBuffer.
void	close()	Closes the transport.
TByteBuffer	flip()	Convenience method to call flip() on the underlying NIO ByteBuffer.
ByteBuffer	getByteBuffer()	Gets the underlying NIO ByteBuffer.
boolean	isOpen()	Queries whether the transport is open.
void	open()	Opens the transport for reading/writing.
int	read(byte[] buf, int off, int len)	Reads up to len bytes into buffer buf, starting at offset off.
byte[]	toByteArray()	Convenience method to convert the underlying NIO ByteBuffer to a plain old byte array.
void	write(byte[] buf, int off, int len)	Writes up to len bytes from the buffer.

Methods inherited from class org.apache.thrift.transport.TEndpointTransport

checkReadBytesAvailable, countConsumedMessageBytes, getConfiguration, getMaxFrameSize, getMaxMessageSize, resetConsumedMessageSize, setMaxFrameSize, updateKnownMessageSize

Methods inherited from class org.apache.thrift.transport.TTransport

consumeBuffer, flush, getBuffer, getBufferPosition, getBytesRemainingInBuffer, peek, read, readAll, write, write

Methods inherited from class java.lang.Object

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

Constructor Details

TByteBuffer

public TByteBuffer(TConfiguration configuration,
 ByteBuffer byteBuffer)
            throws TTransportException

Creates a new TByteBuffer wrapping a given NIO ByteBuffer and custom TConfiguration.

Parameters:

configuration - the custom TConfiguration.

byteBuffer - the NIO ByteBuffer to wrap.

Throws:

TTransportException - on error.

TByteBuffer

public TByteBuffer(ByteBuffer byteBuffer)
            throws TTransportException

Creates a new TByteBuffer wrapping a given NIO ByteBuffer.

Parameters:

byteBuffer - the NIO ByteBuffer to wrap.

Throws:

TTransportException - on error.

Method Details

isOpen

public boolean isOpen()

Description copied from class: TTransport

Queries whether the transport is open.

Specified by:

isOpen in class TTransport

Returns:

True if the transport is open.

open

public void open()

Description copied from class: TTransport

Opens the transport for reading/writing.

Specified by:

open in class TTransport

close

public void close()

Description copied from class: TTransport

Closes the transport.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class TTransport

read

public int read(byte[] buf,
 int off,
 int len)
         throws TTransportException

Description copied from class: TTransport

Reads up to len bytes into buffer buf, starting at offset off.

Specified by:

read in class TTransport

Parameters:

buf - Array to read into

off - Index to start reading at

len - Maximum number of bytes to read

Returns:

The number of bytes actually read

Throws:

TTransportException - if there was an error reading data

write

public void write(byte[] buf,
 int off,
 int len)
           throws TTransportException

Description copied from class: TTransport

Writes up to len bytes from the buffer.

Specified by:

write in class TTransport

Parameters:

buf - The output data buffer

off - The offset to start writing from

len - The number of bytes to write

Throws:

TTransportException - if there was an error writing data

getByteBuffer

public ByteBuffer getByteBuffer()

Gets the underlying NIO ByteBuffer.

Returns:

the underlying NIO ByteBuffer.

clear

public TByteBuffer clear()

Convenience method to call clear() on the underlying NIO ByteBuffer.

Returns:

this instance.

flip

public TByteBuffer flip()

Convenience method to call flip() on the underlying NIO ByteBuffer.

Returns:

this instance.

toByteArray

public byte[] toByteArray()

Convenience method to convert the underlying NIO ByteBuffer to a plain old byte array.

Returns:

the byte array backing the underlying NIO ByteBuffer.