TFastFramedTransport (Thrift Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.thrift.transport
Class TFastFramedTransport

java.lang.Object
  org.apache.thrift.transport.TTransport
      org.apache.thrift.transport.TFastFramedTransport

public class TFastFramedTransport
extends TTransport
extends TTransport

This transport is wire compatible with TFramedTransport, but makes use of reusable, expanding read and write buffers in order to avoid allocating new byte[]s all the time. Since the buffers only expand, you should probably only use this transport if your messages are not too variably large, unless the persistent memory cost is not an issue. This implementation is NOT threadsafe.

Nested Class Summary
`static class`	`TFastFramedTransport.Factory`

Field Summary
`static int`	`DEFAULT_BUF_CAPACITY` How big should the default read and write buffers be?
`static int`	`DEFAULT_MAX_LENGTH` How big is the largest allowable frame? Defaults to Integer.MAX_VALUE.

Constructor Summary
`TFastFramedTransport(TTransport underlying)` Create a new `TFastFramedTransport`.
`TFastFramedTransport(TTransport underlying, int initialBufferCapacity)` Create a new `TFastFramedTransport`.
`TFastFramedTransport(TTransport underlying, int initialBufferCapacity, int maxLength)`

Method Summary
`void`	`close()` Closes the transport.
`void`	`consumeBuffer(int len)` Consume len bytes from the underlying buffer.
`void`	`flush()` Flush any pending data out of a transport buffer.
`byte[]`	`getBuffer()` Access the protocol's underlying buffer directly.
`int`	`getBufferPosition()` Return the index within the underlying buffer that specifies the next spot that should be read from.
`int`	`getBytesRemainingInBuffer()` Get the number of bytes remaining in the underlying buffer.
`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.
`void`	`write(byte[] buf, int off, int len)` Writes up to len bytes from the buffer.

Methods inherited from class org.apache.thrift.transport.TTransport
`peek, readAll, write`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

DEFAULT_BUF_CAPACITY

public static final int DEFAULT_BUF_CAPACITY

How big should the default read and write buffers be?

See Also:: Constant Field Values

DEFAULT_MAX_LENGTH

public static final int DEFAULT_MAX_LENGTH

How big is the largest allowable frame? Defaults to Integer.MAX_VALUE.

See Also:: Constant Field Values

Constructor Detail

TFastFramedTransport

public TFastFramedTransport(TTransport underlying)

Create a new TFastFramedTransport. Use the defaults for initial buffer size and max frame length.

Parameters:: underlying - Transport that real reads and writes will go through to.

TFastFramedTransport

public TFastFramedTransport(TTransport underlying,
                            int initialBufferCapacity)

Create a new TFastFramedTransport. Use the specified initial buffer capacity and the default max frame length.

Parameters:: underlying - Transport that real reads and writes will go through to.; initialBufferCapacity - The initial size of the read and write buffers. In practice, it's not critical to set this unless you know in advance that your messages are going to be very large.

TFastFramedTransport

public TFastFramedTransport(TTransport underlying,
                            int initialBufferCapacity,
                            int maxLength)

Parameters:: underlying - Transport that real reads and writes will go through to.; initialBufferCapacity - The initial size of the read and write buffers. In practice, it's not critical to set this unless you know in advance that your messages are going to be very large. (You can pass TFramedTransportWithReusableBuffer.DEFAULT_BUF_CAPACITY if you're only using this constructor because you want to set the maxLength.); maxLength - The max frame size you are willing to read. You can use this parameter to limit how much memory can be allocated.

Method Detail