Package org.apache.thrift.transport

Class TNonblockingSocket

java.lang.Object

org.apache.thrift.transport.TTransport

org.apache.thrift.transport.TEndpointTransport

org.apache.thrift.transport.TNonblockingTransport

org.apache.thrift.transport.TNonblockingSocket

All Implemented Interfaces:

Closeable, AutoCloseable, SocketAddressProvider

Direct Known Subclasses:

TNonblockingSSLSocket

public class TNonblockingSocket
extends TNonblockingTransport
implements SocketAddressProvider

Transport for use with async client.

Field Summary

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

knownMessageSize, remainingMessageSize

Constructor Summary

Constructors

Constructor	Description
TNonblockingSocket(String host, int port)
TNonblockingSocket(String host, int port, int timeout)	Create a new nonblocking socket transport that will be connected to host:port.
TNonblockingSocket(SocketChannel socketChannel)	Constructor that takes an already created socket.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the socket.
boolean	finishConnect()	Non-blocking connection completion.
void	flush()	Noop.
SocketAddress	getLocalSocketAddress()
SocketAddress	getRemoteSocketAddress()
SocketChannel	getSocketChannel()	Returns a reference to the underlying SocketChannel.
boolean	isOpen()	Checks whether the socket is connected.
void	open()	Do not call, the implementation provides its own lazy non-blocking connect.
int	read(byte[] buf, int off, int len)	Reads from the underlying input stream if not null.
int	read(ByteBuffer buffer)	Perform a nonblocking read into buffer.
SelectionKey	registerSelector(Selector selector, int interests)	Register the new SocketChannel with our Selector, indicating we'd like to be notified when it's ready for I/O.
void	setTimeout(int timeout)	Sets the socket timeout, although this implementation never uses blocking operations so it is unused.
boolean	startConnect()	Non-blocking connection initialization.
String	toString()
void	write(byte[] buf, int off, int len)	Writes to the underlying output stream if not null.
int	write(ByteBuffer buffer)	Perform a nonblocking write of the data in buffer;

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

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

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

TNonblockingSocket

public TNonblockingSocket(String host,
 int port)
                   throws IOException,
TTransportException

Throws:

IOException

TTransportException

TNonblockingSocket

public TNonblockingSocket(String host,
 int port,
 int timeout)
                   throws IOException,
TTransportException

Create a new nonblocking socket transport that will be connected to host:port.

Parameters:

host -

port -

Throws:

IOException

TTransportException

TNonblockingSocket

public TNonblockingSocket(SocketChannel socketChannel)
                   throws IOException,
TTransportException

Constructor that takes an already created socket.

Parameters:

socketChannel - Already created SocketChannel object

Throws:

IOException - if there is an error setting up the streams

TTransportException

Method Details

registerSelector

public SelectionKey registerSelector(Selector selector,
 int interests)
                              throws IOException

Register the new SocketChannel with our Selector, indicating we'd like to be notified when it's ready for I/O.

Specified by:

registerSelector in class TNonblockingTransport

Parameters:

selector -

Returns:

the selection key for this socket.

Throws:

IOException

setTimeout

public void setTimeout(int timeout)

Sets the socket timeout, although this implementation never uses blocking operations so it is unused.

Parameters:

timeout - Milliseconds timeout

getSocketChannel

public SocketChannel getSocketChannel()

Returns a reference to the underlying SocketChannel.

isOpen

public boolean isOpen()

Checks whether the socket is connected.

Specified by:

isOpen in class TTransport

Returns:

True if the transport is open.

open

public void open()
          throws TTransportException

Do not call, the implementation provides its own lazy non-blocking connect.

Specified by:

open in class TTransport

Throws:

TTransportException - if the transport could not be opened

read

public int read(ByteBuffer buffer)
         throws TTransportException

Perform a nonblocking read into buffer.

Overrides:

read in class TTransport

Parameters:

buffer - The buffer into which bytes are to be transferred

Returns:

The number of bytes read, possibly zero, or -1 if the channel has reached end-of-stream

Throws:

TTransportException - if there was an error reading data

read

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

Reads from the underlying input stream if not null.

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 int write(ByteBuffer buffer)
          throws TTransportException

Perform a nonblocking write of the data in buffer;

Overrides:

write in class TTransport

Parameters:

buffer - The buffer from which bytes are to be retrieved

Returns:

The number of bytes written, possibly zero

Throws:

TTransportException - if there was an error writing data

write

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

Writes to the underlying output stream if not null.

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

flush

public void flush()
           throws TTransportException

Noop.

Overrides:

flush in class TTransport

Throws:

TTransportException - if there was an error writing out data.

close

public void close()

Closes the socket.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class TTransport

startConnect

public boolean startConnect()
                     throws IOException

Non-blocking connection initialization.

Specified by:

startConnect in class TNonblockingTransport

Throws:

IOException

See Also:

• SocketChannel.connect(SocketAddress remote)

finishConnect

public boolean finishConnect()
                      throws IOException

Non-blocking connection completion.

Specified by:

finishConnect in class TNonblockingTransport

Throws:

IOException

See Also:

• SocketChannel.finishConnect()

toString

public String toString()

Overrides:

toString in class Object

getRemoteSocketAddress

public SocketAddress getRemoteSocketAddress()

Specified by:

getRemoteSocketAddress in interface SocketAddressProvider

getLocalSocketAddress

public SocketAddress getLocalSocketAddress()

Specified by:

getLocalSocketAddress in interface SocketAddressProvider