Package org.apache.thrift.transport

Class TSocket

java.lang.Object

org.apache.thrift.transport.TTransport

org.apache.thrift.transport.TEndpointTransport

org.apache.thrift.transport.TIOStreamTransport

org.apache.thrift.transport.TSocket

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class TSocket
extends TIOStreamTransport

Socket implementation of the TTransport interface. To be commented soon!

Field Summary

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

inputStream_, outputStream_

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

knownMessageSize, remainingMessageSize

Constructor Summary

Constructors

Constructor	Description
TSocket(java.lang.String host, int port)	Creates a new unconnected socket that will connect to the given host on the given port.
TSocket(java.net.Socket socket)	Constructor that takes an already created socket.
TSocket(TConfiguration config, java.lang.String host, int port)	Creates a new unconnected socket that will connect to the given host on the given port.
TSocket(TConfiguration config, java.lang.String host, int port, int timeout)	Creates a new unconnected socket that will connect to the given host on the given port.
TSocket(TConfiguration config, java.lang.String host, int port, int socketTimeout, int connectTimeout)	Creates a new unconnected socket that will connect to the given host on the given port, with a specific connection timeout and a specific socket timeout.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the socket.
java.net.Socket	getSocket()	Returns a reference to the underlying socket.
boolean	isOpen()	Checks whether the socket is connected.
void	open()	Connects the socket, creating a new socket object if necessary.
void	setConnectTimeout(int timeout)	Sets the time after which the connection attempt will time out
void	setSocketTimeout(int timeout)	Sets the socket timeout
void	setTimeout(int timeout)	Sets the socket timeout and connection timeout.

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

flush, read, write

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

checkReadBytesAvailable, countConsumedMessageBytes, getConfiguration, getMaxMessageSize, resetConsumedMessageSize, updateKnownMessageSize

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

consumeBuffer, 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 Detail

TSocket

public TSocket(java.net.Socket socket)
        throws TTransportException

Constructor that takes an already created socket.

Parameters:

socket - Already created socket object

Throws:

TTransportException - if there is an error setting up the streams

TSocket

public TSocket(TConfiguration config,
               java.lang.String host,
               int port)
        throws TTransportException

Creates a new unconnected socket that will connect to the given host on the given port.

Parameters:

config - check config

host - Remote host

port - Remote port

Throws:

TTransportException

TSocket

public TSocket(java.lang.String host,
               int port)
        throws TTransportException

Creates a new unconnected socket that will connect to the given host on the given port.

Parameters:

host - Remote host

port - Remote port

Throws:

TTransportException

TSocket

public TSocket(TConfiguration config,
               java.lang.String host,
               int port,
               int timeout)
        throws TTransportException

Creates a new unconnected socket that will connect to the given host on the given port.

Parameters:

config - check config

host - Remote host

port - Remote port

timeout - Socket timeout and connection timeout

Throws:

TTransportException

TSocket

public TSocket(TConfiguration config,
               java.lang.String host,
               int port,
               int socketTimeout,
               int connectTimeout)
        throws TTransportException

Creates a new unconnected socket that will connect to the given host on the given port, with a specific connection timeout and a specific socket timeout.

Parameters:

config - check config

host - Remote host

port - Remote port

socketTimeout - Socket timeout

connectTimeout - Connection timeout

Throws:

TTransportException

Method Detail

setTimeout

public void setTimeout(int timeout)

Sets the socket timeout and connection timeout.

Parameters:

timeout - Milliseconds timeout

setConnectTimeout

public void setConnectTimeout(int timeout)

Sets the time after which the connection attempt will time out

Parameters:

timeout - Milliseconds timeout

setSocketTimeout

public void setSocketTimeout(int timeout)

Sets the socket timeout

Parameters:

timeout - Milliseconds timeout

getSocket

public java.net.Socket getSocket()

Returns a reference to the underlying socket.

isOpen

public boolean isOpen()

Checks whether the socket is connected.

Overrides:

isOpen in class TIOStreamTransport

Returns:

false after close is called.

open

public void open()
          throws TTransportException

Connects the socket, creating a new socket object if necessary.

Overrides:

open in class TIOStreamTransport

Throws:

TTransportException - if the transport could not be opened

close

public void close()

Closes the socket.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Overrides:

close in class TIOStreamTransport