com.thinkaurelius.thrift.util.mem

Class FastMemoryOutputTransport

java.lang.Object

org.apache.thrift.transport.TTransport

com.thinkaurelius.thrift.util.mem.FastMemoryOutputTransport

public class FastMemoryOutputTransport
extends org.apache.thrift.transport.TTransport

Field Summary

Fields

Modifier and Type	Field and Description
protected Buffer	buf The byte array containing the bytes written.
protected int	count The number of bytes written.
protected int	streamPos

Constructor Summary

Constructors

Constructor and Description
FastMemoryOutputTransport(int size, boolean useHeapBasedAllocation) Constructs a new FastMemoryOutputTransport with a default size of size bytes.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this transport.
boolean	isFullyStreamed()
boolean	isOpen()
void	open()
int	read(byte[] buf, int off, int len)
int	size() Returns the total number of bytes written to this transport so far.
int	streamTo(org.apache.thrift.transport.TNonblockingTransport transport) Start writing accumulated content to the given transport or continue from the previous stop point (this method is stateful).
String	toString() Returns the contents of this ByteArrayOutputStream as a string.
void	write(byte[] buffer, int offset, int len) Writes count bytes from the byte buffer buffer starting at offset index to this stream.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

buf

protected Buffer buf

The byte array containing the bytes written.

count

protected int count

The number of bytes written.

streamPos

protected int streamPos

Constructor Detail

FastMemoryOutputTransport

public FastMemoryOutputTransport(int size,
                         boolean useHeapBasedAllocation)

Constructs a new FastMemoryOutputTransport with a default size of size bytes. If more than size bytes are written to this instance, the underlying byte buffer will expanded.

Parameters:

size - initial size for the underlying byte buffer, must be non-negative.

useHeapBasedAllocation - Flag to trigger ByteBuffer.allocate(int) or off-heap memory allocation for storage.

Throws:

IllegalArgumentException - if size < 0.

Method Detail

isOpen

public boolean isOpen()

Specified by:

isOpen in class org.apache.thrift.transport.TTransport

open

public void open()
          throws org.apache.thrift.transport.TTransportException

Specified by:

open in class org.apache.thrift.transport.TTransport

Throws:

org.apache.thrift.transport.TTransportException

close

public void close()

Closes this transport. This releases system resources used for this stream.

Specified by:

close in class org.apache.thrift.transport.TTransport

read

public int read(byte[] buf,
       int off,
       int len)
         throws org.apache.thrift.transport.TTransportException

Specified by:

read in class org.apache.thrift.transport.TTransport

Throws:

org.apache.thrift.transport.TTransportException

size

public int size()

Returns the total number of bytes written to this transport so far.

Returns:

the number of bytes written to this stream.

streamTo

public int streamTo(org.apache.thrift.transport.TNonblockingTransport transport)
             throws IOException

Start writing accumulated content to the given transport or continue from the previous stop point (this method is stateful).

Parameters:

transport - The transport to write contents into.

Returns:

The number of bytes actually written to the transport.

Throws:

IOException - on any I/O related error, such as socket disconnect.

isFullyStreamed

public boolean isFullyStreamed()

Returns:

true if all of the data in current stream has been written to the transport via streamTo method, false otherwise.

toString

public String toString()

Returns the contents of this ByteArrayOutputStream as a string. Any changes made to the receiver after returning will not be reflected in the string returned to the caller.

Overrides:

toString in class Object

Returns:

this stream's current contents as a string.

write

public void write(byte[] buffer,
         int offset,
         int len)

Writes count bytes from the byte buffer buffer starting at offset index to this stream.

Specified by:

write in class org.apache.thrift.transport.TTransport

Parameters:

buffer - the buffer to be written.

offset - the initial position in buffer to retrieve bytes.

len - the number of bytes of buffer to write.

Throws:

NullPointerException - if buffer is null.

IndexOutOfBoundsException - if offset < 0 or len < 0, or if offset + len is greater than the length of buffer.