com.crankuptheamps.client

Class TCPTransport

java.lang.Object

com.crankuptheamps.client.TCPTransport

All Implemented Interfaces:

Transport, java.lang.AutoCloseable

Direct Known Subclasses:

TCPSTransport

public class TCPTransport
extends java.lang.Object
implements Transport

Implements an AMPS transport over standard TCP/IP. Use this transport by connecting to URIs beginning with tcp://.

Field Summary

Fields

Modifier and Type	Field and Description
protected TCPTransportImpl	_impl

Constructor Summary

Constructors

Constructor and Description
TCPTransport(Protocol msgType) Constructs a new TCPTransport instance with the specified message type.
TCPTransport(Protocol protocol, java.util.Properties properties) Constructs a new TCPTransport instance with the specified protocol and properties.
TCPTransport(Protocol msgType, TCPTransportImpl impl)

Method Summary

Modifier and Type	Method and Description
Message	allocateMessage() Allocates a new message using the underlying protocol.
void	close() Closes the transport, disconnecting it from the server.
void	connect(java.net.URI uri) Connects to the specified URI using the underlying implementation.
protected TCPTransportImpl	constructTransportImpl(Protocol protocol, java.util.Properties properties) Constructs a new TCPTransport instance with the specified protocol and properties.
static TCPTransport	createTransport(Protocol messageType) Factory method for creating a new instance of TCPTransport.
static TCPTransport	createTransport(Protocol messageType, TCPTransportImpl impl) Factory method for creating a new instance of TCPTransport.
void	disconnect() Disconnects the transport from the server.
long	flush() Flushes the transport's write queue.
long	flush(long timeout) Flushes the transport's write queue with a specified timeout.
static int	getDefaultConnectTimeout() Returns the default connect timeout used for new connections.
static int	getDefaultReadTimeout() Returns the default read timeout used for socket reads.
AMPSRunnable	getIdleRunnable() Gets the transport's currently registered idle task, or null if there is none.
int	getVersion() Returns the version of the transport.
void	handleCloseEvent(int failedVersion_, java.lang.String message, java.lang.Exception e) Handles a close event, notifying the underlying implementation.
void	initFromClient(Client client) Called by Client before calling connect to give Transport access to any information in the Client needed by the Transport such as message handler, exceptionListener, etc.
static boolean	isDaemon() Checks if daemon threads are being used by default.
long	readQueueSize() Returns the size of the read queue.
void	send(Message message) Sends the specified message.
void	sendWithoutRetry(Message message) Sends a message without retrying, handling the serialization process.
static void	setDaemon(boolean daemonThreads) Sets whether daemon threads should be used by default.
static void	setDefaultConnectTimeout(int defaultConnectTimeoutMillis_) Returns the default connect timeout used for new connections.
static void	setDefaultReadTimeout(int defaultReadTimeoutMillis_) Sets the default read timeout used for socket reads.
void	setDisconnectHandler(TransportDisconnectHandler dh) Sets the handler for disconnect events.
void	setExceptionListener(java.beans.ExceptionListener exceptionListener) Sets the listener for exception events.
void	setIdleRunnable(AMPSRunnable runnable) Sets the idle runnable for the transport.
void	setMessageHandler(MessageHandler ml) Sets the message handler for this transport.
void	setReadTimeout(int readTimeout_) Sets the read timeout for the transport.
void	setThreadCreatedHandler(ThreadCreatedHandler tch_) Sets the handler for newly created threads.
void	setTransportFilter(TransportFilter filter) Sets the transport filter.
java.net.Socket	socket() Returns the underlying socket of the transport.
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

_impl

protected TCPTransportImpl _impl

Constructor Detail

TCPTransport

public TCPTransport(Protocol protocol,
                    java.util.Properties properties)

Constructs a new TCPTransport instance with the specified protocol and properties.

Parameters:

protocol - The protocol used by the transport.

properties - The properties to configure the transport.

TCPTransport

public TCPTransport(Protocol msgType)

Constructs a new TCPTransport instance with the specified message type.

Parameters:

msgType - The protocol message type.

TCPTransport

public TCPTransport(Protocol msgType,
                    TCPTransportImpl impl)

Method Detail

constructTransportImpl

protected TCPTransportImpl constructTransportImpl(Protocol protocol,
                                                  java.util.Properties properties)

Constructs a new TCPTransport instance with the specified protocol and properties.

Parameters:

protocol - The protocol used by the transport.

properties - The properties to configure the transport.

Returns:

A new TCPTransportImpl instance.

setDaemon

public static void setDaemon(boolean daemonThreads)

Sets whether daemon threads should be used by default.

Parameters:

daemonThreads - True to use daemon threads; false otherwise.

isDaemon

public static boolean isDaemon()

Checks if daemon threads are being used by default.

Returns:

True if daemon threads are used; false otherwise.

setDefaultReadTimeout

public static void setDefaultReadTimeout(int defaultReadTimeoutMillis_)

Sets the default read timeout used for socket reads. This value is used for new connections, but not applied to existing connections. A 0 value means to wait forever for incoming data, or until an error occurs.

Parameters:

defaultReadTimeoutMillis_ - The default read timeout in milliseconds.

getDefaultReadTimeout

public static int getDefaultReadTimeout()

Returns the default read timeout used for socket reads. A 0 value means to wait forever for incoming data, or until an error occurs.

Returns:

The current default read timeout, in milliseconds.

setDefaultConnectTimeout

public static void setDefaultConnectTimeout(int defaultConnectTimeoutMillis_)

Returns the default connect timeout used for new connections.

Parameters:

defaultConnectTimeoutMillis_ - The default connect timeout, in milliseconds. A 0 value means no timeout is specified, i.e. wait until the OS returns an error.

getDefaultConnectTimeout

public static int getDefaultConnectTimeout()

Returns the default connect timeout used for new connections.

Returns:

The default connect timeout in milliseconds. A 0 value means no timeout is specified, i.e. wait until the OS returns an error.

createTransport

public static TCPTransport createTransport(Protocol messageType)

Factory method for creating a new instance of TCPTransport.

Parameters:

messageType - The protocol message type for the transport.

Returns:

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

createTransport

public static 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 ml)

Sets the message handler for this transport.

Specified by:

setMessageHandler in interface Transport

Parameters:

ml - The message handler to set.

setThreadCreatedHandler

public void setThreadCreatedHandler(ThreadCreatedHandler tch_)

Sets the handler for newly created threads.

Specified by:

setThreadCreatedHandler in interface Transport

Parameters:

tch_ - The thread created handler to set.

setDisconnectHandler

public void setDisconnectHandler(TransportDisconnectHandler dh)

Sets the handler for disconnect events.

Specified by:

setDisconnectHandler in interface Transport

Parameters:

dh - The disconnect handler to set.

setExceptionListener

public void setExceptionListener(java.beans.ExceptionListener exceptionListener)

Sets the listener for exception events.

Specified by:

setExceptionListener in interface Transport

Parameters:

exceptionListener - The exception listener to set.

setTransportFilter

public void setTransportFilter(TransportFilter filter)

Sets the transport filter.

Specified by:

setTransportFilter in interface Transport

Parameters:

filter - The transport filter to set.

connect

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

Connects to the specified URI using the underlying implementation.

Specified by:

connect in interface Transport

Parameters:

uri - The URI to connect to.

Throws:

ConnectionRefusedException - If the connection is refused.

AlreadyConnectedException - If the transport is already connected.

InvalidURIException - If the URI is invalid.

close

public void close()
           throws java.lang.Exception

Closes the transport, disconnecting it from the server.

Specified by:

close in interface java.lang.AutoCloseable

Throws:

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

disconnect

public void disconnect()

Disconnects the transport from the server.

Specified by:

disconnect in interface Transport

handleCloseEvent

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

Handles a close event, notifying the underlying implementation.

Specified by:

handleCloseEvent in interface Transport

Parameters:

failedVersion_ - The failed version.

message - The message associated with the close event.

e - The exception associated with the close event.

Throws:

DisconnectedException - If the transport is disconnected.

RetryOperationException - If a retry operation is needed.

sendWithoutRetry

public void sendWithoutRetry(Message message)
                      throws DisconnectedException

Sends a message without retrying, handling the serialization process.

Specified by:

sendWithoutRetry in interface Transport

Parameters:

message - The message to send.

Throws:

DisconnectedException - If the transport is disconnected.

send

public void send(Message message)
          throws DisconnectedException

Sends the specified message. This method handles synchronization, retries, and exception handling.

Specified by:

send in interface Transport

Parameters:

message - The message to send.

Throws:

DisconnectedException - If the transport is disconnected.

allocateMessage

public Message allocateMessage()

Allocates a new message using the underlying protocol.

Specified by:

allocateMessage in interface Transport

Returns:

The allocated message.

writeQueueSize

public long writeQueueSize()
                    throws DisconnectedException

Returns the size of the write queue.

Specified by:

writeQueueSize in interface Transport

Returns:

The size of the write queue.

Throws:

DisconnectedException - If the transport is disconnected.

readQueueSize

public long readQueueSize()
                   throws DisconnectedException

Returns the size of the read queue.

Specified by:

readQueueSize in interface Transport

Returns:

The size of the read queue.

Throws:

DisconnectedException - If the transport is disconnected.

flush

public long flush()
           throws DisconnectedException

Flushes the transport's write queue.

Specified by:

flush in interface Transport

Returns:

The number of messages flushed.

Throws:

DisconnectedException - If the transport is disconnected.

flush

public long flush(long timeout)
           throws DisconnectedException

Flushes the transport's write queue with a specified timeout.

Specified by:

flush in interface Transport

Parameters:

timeout - The maximum time to wait for flushing, in milliseconds.

Returns:

The number of messages flushed.

Throws:

DisconnectedException - If the transport is disconnected.

socket

public java.net.Socket socket()

Returns the underlying socket of the transport.

Returns:

The underlying socket.

getVersion

public int getVersion()

Returns the version of the transport.

Specified by:

getVersion in interface Transport

Returns:

The version of the transport.

setReadTimeout

public void setReadTimeout(int readTimeout_)

Sets the read timeout for the transport.

Specified by:

setReadTimeout in interface Transport

Parameters:

readTimeout_ - The read timeout in milliseconds.

getIdleRunnable

public AMPSRunnable getIdleRunnable()

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

Specified by:

getIdleRunnable in interface Transport

Returns:

The currently registered idle runnable or null.

setIdleRunnable

public void setIdleRunnable(AMPSRunnable runnable)

Sets the idle runnable for the transport.

Specified by:

setIdleRunnable in interface Transport

Parameters:

runnable - The idle runnable to set.

initFromClient

public void initFromClient(Client client)

Description copied from interface: Transport

Called by Client before calling connect to give Transport access to any information in the Client needed by the Transport such as message handler, exceptionListener, etc.

Specified by:

initFromClient in interface Transport

Parameters:

client - The Client that will be using the Transport.