com.crankuptheamps.client

Class TCPTransportImpl

java.lang.Object

com.crankuptheamps.client.TCPTransportImpl

Direct Known Subclasses:

TCPSTransportImpl

public class TCPTransportImpl
extends java.lang.Object

Socket implementation for TCPTransport. TCP Transport delegates to an instance of this class. This is used internally by the client's transport. There is usually no reason to make direct use of it. Its functionality is best accessed via the client instance.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.net.URI	_addr
protected Client	_client
protected TransportFilter	_filter
protected boolean	_handshakeSetStreams
protected boolean	_httpPreflight
protected AMPSRunnable	_idleRunnable
protected java.io.InputStream	_inputStream
java.util.concurrent.locks.Lock	_lock
protected java.io.OutputStream	_outputStream
protected java.net.Socket	_socket

Constructor Summary

Constructors

Constructor and Description
TCPTransportImpl(Protocol messageType, java.util.Properties properties, TransportFilter filter) Constructs a TCPTransportImpl object with the specified message type, properties, and transport filter.

Method Summary

Modifier and Type	Method and Description
protected void	applySocketProperties(java.util.Properties properties_) Applies socket properties based on the provided properties.
protected void	applySocketProperty(java.lang.Object key, java.lang.Object value)
void	connect(java.net.URI addr) Connects the transport to the specified URI.
protected void	connectSocket(java.net.URI addr, URIProperties properties)
protected java.net.Socket	createSocket() Creates a socket using the default socket factory.
protected void	createStream(java.net.URI addr)
TCPTransport	createTransport(Protocol messageType, TCPTransportImpl impl) Factory method for creating a new instance of TCPTransport.
void	disconnect() Initiates the disconnection process.
long	flush() Flushes the data in the write queue.
long	flush(long timeout) Flushes the data in the write queue with a specified timeout.
AMPSRunnable	getIdleRunnable() Gets the transport impl's currently registered idle task, or null if there is none.
void	handleCloseEvent(int failedVersion, java.lang.String message, java.lang.Exception e_) Handles the event of the connection being closed.
protected void	handshake() Performs the handshake for the TCP connection.
void	initFromClient(Client client)
long	readQueueSize() Returns the size of the read queue.
void	send(java.nio.ByteBuffer buf) Sends data through the socket.
void	setConnectTimeout(int connectTimeoutMillis_) Sets the connect timeout for the TCP transport.
void	setDisconnectHandler(TransportDisconnectHandler h) Sets the disconnect handler for the transport.
void	setExceptionListener(java.beans.ExceptionListener exceptionListener) Sets the exception listener for the transport.
void	setIdleRunnable(AMPSRunnable runnable)
void	setMessageHandler(MessageHandler h) Sets the message handler for the transport.
void	setReadTimeout(int readTimeoutMillis_) Sets the read timeout for the TCP transport.
void	setThreadCreatedHandler(ThreadCreatedHandler h) Sets the thread created handler for the transport.
void	setTransportFilter(TransportFilter filter) Sets the transport filter for the transport.
java.net.Socket	socket() Retrieves the underlying socket.
long	writeQueueSize() Returns the size of the write queue.

Methods inherited from class java.lang.Object

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

Field Detail

_client

protected Client _client

_addr

protected java.net.URI _addr

_socket

protected java.net.Socket _socket

_inputStream

protected java.io.InputStream _inputStream

_outputStream

protected java.io.OutputStream _outputStream

_lock

public final java.util.concurrent.locks.Lock _lock

_filter

protected TransportFilter _filter

_idleRunnable

protected volatile AMPSRunnable _idleRunnable

_httpPreflight

protected boolean _httpPreflight

_handshakeSetStreams

protected boolean _handshakeSetStreams

Constructor Detail

TCPTransportImpl

public TCPTransportImpl(Protocol messageType,
                        java.util.Properties properties,
                        TransportFilter filter)

Constructs a TCPTransportImpl object with the specified message type, properties, and transport filter.

Parameters:

messageType - The message type associated with the transport.

properties - The properties to be applied to the transport.

filter - The transport filter to be applied.

Method Detail

createTransport

public TCPTransport createTransport(Protocol messageType,
                                    TCPTransportImpl impl)

Factory method for creating a new instance of TCPTransport.

Parameters:

messageType - The protocol message type for the transport.

impl - The underlying implementation for the new transport.

Returns:

A new instance of TCPTransport with the specified protocol message type.

setMessageHandler

public void setMessageHandler(MessageHandler h)

Sets the message handler for the transport.

Parameters:

h - The message handler to be set.

setDisconnectHandler

public void setDisconnectHandler(TransportDisconnectHandler h)

Sets the disconnect handler for the transport.

Parameters:

h - The disconnect handler to be set.

setExceptionListener

public void setExceptionListener(java.beans.ExceptionListener exceptionListener)

Sets the exception listener for the transport.

Parameters:

exceptionListener - The exception listener to be set.

setThreadCreatedHandler

public void setThreadCreatedHandler(ThreadCreatedHandler h)

Sets the thread created handler for the transport.

Parameters:

h - The thread created handler to be set.

setTransportFilter

public void setTransportFilter(TransportFilter filter)

Sets the transport filter for the transport.

Parameters:

filter - The transport filter to be set.

connect

public void connect(java.net.URI addr)
             throws ConnectionRefusedException,
                    AlreadyConnectedException,
                    InvalidURIException

Connects the transport to the specified URI.

Parameters:

addr - The URI to connect to.

Throws:

ConnectionRefusedException - Thrown if the connection is refused.

AlreadyConnectedException - Thrown if the transport is already connected.

InvalidURIException - Thrown if the URI is invalid.

createSocket

protected java.net.Socket createSocket()
                                throws java.lang.Exception

Creates a socket using the default socket factory.

Returns:

A newly created socket.

Throws:

java.lang.Exception - If an error occurs while creating the socket.

connectSocket

protected void connectSocket(java.net.URI addr,
                             URIProperties properties)
                      throws java.lang.Exception

Throws:

java.lang.Exception

createStream

protected void createStream(java.net.URI addr)
                     throws java.io.IOException

Throws:

java.io.IOException

handshake

protected void handshake()
                  throws java.lang.Exception

Performs the handshake for the TCP connection.

Throws:

java.lang.Exception - If an error occurs during the handshake process.

applySocketProperties

protected void applySocketProperties(java.util.Properties properties_)
                              throws java.net.SocketException,
                                     InvalidURIException

Applies socket properties based on the provided properties.

Parameters:

properties_ - The properties to be applied to the socket.

Throws:

java.net.SocketException - If an error occurs while setting socket options.

InvalidURIException - If an invalid URI parameter is encountered.

applySocketProperty

protected void applySocketProperty(java.lang.Object key,
                                   java.lang.Object value)
                            throws java.net.SocketException,
                                   InvalidURIException

Throws:

java.net.SocketException

InvalidURIException

disconnect

public void disconnect()

Initiates the disconnection process.

send

public void send(java.nio.ByteBuffer buf)
          throws DisconnectedException

Sends data through the socket.

Parameters:

buf - The ByteBuffer containing the data to be sent.

Throws:

DisconnectedException - If the socket is disconnected while sending the message.

socket

public java.net.Socket socket()

Retrieves the underlying socket.

Returns:

The underlying socket.

writeQueueSize

public long writeQueueSize()

Returns the size of the write queue.

Returns:

The size of the write queue, which is always 0 in this implementation.

readQueueSize

public long readQueueSize()

Returns the size of the read queue.

Returns:

The size of the read queue, which is always 0 in this implementation.

flush

public long flush()

Flushes the data in the write queue.

Returns:

Always returns 0 as the data has been flushed.

flush

public long flush(long timeout)

Flushes the data in the write queue with a specified timeout.

Parameters:

timeout - The timeout value in milliseconds.

Returns:

Always returns 0 as the data has been flushed.

handleCloseEvent

public void handleCloseEvent(int failedVersion,
                             java.lang.String message,
                             java.lang.Exception e_)
                      throws RetryOperationException,
                             DisconnectedException

Handles the event of the connection being closed.

Parameters:

failedVersion - The version of the failed connection.

message - The message associated with the event.

e_ - The exception that caused the event, if any.

Throws:

RetryOperationException - If a new connection is available and retrying the operation is necessary.

DisconnectedException - If an error occurs during reconnection or disconnection.

setReadTimeout

public void setReadTimeout(int readTimeoutMillis_)

Sets the read timeout for the TCP transport.

Parameters:

readTimeoutMillis_ - The read timeout value in milliseconds.

setConnectTimeout

public void setConnectTimeout(int connectTimeoutMillis_)

Sets the connect timeout for the TCP transport.

Parameters:

connectTimeoutMillis_ - The connect timeout value in milliseconds.

getIdleRunnable

public AMPSRunnable getIdleRunnable()

Gets the transport impl's currently registered idle task, or null if there is none.

Returns:

The currently registered idle runnable or null.

setIdleRunnable

public void setIdleRunnable(AMPSRunnable runnable)

initFromClient

public void initFromClient(Client client)