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
ByteBuffer-backed implementation of TTransport.
-
Field Summary
Fields inherited from class org.apache.thrift.transport.TEndpointTransport
knownMessageSize, remainingMessageSize
-
Constructor Summary
ConstructorDescriptionTByteBuffer
(ByteBuffer byteBuffer) Creates a new TByteBuffer wrapping a given NIO ByteBuffer. -
Method Summary
Modifier and TypeMethodDescriptionclear()
Convenience method to call clear() on the underlying NIO ByteBuffer.void
close()
Closes the transport.flip()
Convenience method to call flip() on the underlying NIO ByteBuffer.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[]
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
-
Constructor Details
-
TByteBuffer
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 classTTransport
- 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 classTTransport
-
close
public void close()Description copied from class:TTransport
Closes the transport.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in classTTransport
-
read
Description copied from class:TTransport
Reads up to len bytes into buffer buf, starting at offset off.- Specified by:
read
in classTTransport
- Parameters:
buf
- Array to read intooff
- Index to start reading atlen
- Maximum number of bytes to read- Returns:
- The number of bytes actually read
- Throws:
TTransportException
- if there was an error reading data
-
write
Description copied from class:TTransport
Writes up to len bytes from the buffer.- Specified by:
write
in classTTransport
- Parameters:
buf
- The output data bufferoff
- The offset to start writing fromlen
- The number of bytes to write- Throws:
TTransportException
- if there was an error writing data
-
getByteBuffer
Gets the underlying NIO ByteBuffer.- Returns:
- the underlying NIO ByteBuffer.
-
clear
Convenience method to call clear() on the underlying NIO ByteBuffer.- Returns:
- this instance.
-
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.
-