com.crankuptheamps.client

Interface Transport

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

TCPSTransport, TCPTransport

public interface Transport
extends java.lang.AutoCloseable

Interface that is used to manage and configure connections to AMPS. Typically a transport is created and used internally by a Client instance. There is usually no reason to make direct use of it. Its functionality is best accessed via the client instance.

Method Summary

Modifier and Type	Method and Description
Message	allocateMessage()
void	connect(java.net.URI uri) Connect to an AMPS server.
void	disconnect()
long	flush()
long	flush(long timeout)
AMPSRunnable	getIdleRunnable() Gets the AMPSRunnable that is invoked during idle-time processing for this connection.
int	getVersion()
void	handleCloseEvent(int failedVersion_, java.lang.String message, java.lang.Exception e)
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.
long	readQueueSize()
void	send(Message message)
void	sendWithoutRetry(Message message)
void	setDisconnectHandler(TransportDisconnectHandler dh)
void	setExceptionListener(java.beans.ExceptionListener exceptionListener)
void	setIdleRunnable(AMPSRunnable runnable) Sets a AMPSRunnable that is invoked during idle-time processing for this connection.
void	setMessageHandler(MessageHandler ml)
void	setReadTimeout(int readTimeoutMillis_)
void	setThreadCreatedHandler(ThreadCreatedHandler ml)
void	setTransportFilter(TransportFilter filter_) Sets a TransportFilter that filters raw bytes before send and after receive.
long	writeQueueSize()

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

connect

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

Connect to an AMPS server.

Parameters:

uri - Specifies the protocol and address of the server.

Throws:

ConnectionRefusedException - The connection was refused by the server.

AlreadyConnectedException - The transport is already connected to a server.

InvalidURIException - The URI is invalid.

disconnect

void disconnect()

setMessageHandler

void setMessageHandler(MessageHandler ml)

setDisconnectHandler

void setDisconnectHandler(TransportDisconnectHandler dh)

setExceptionListener

void setExceptionListener(java.beans.ExceptionListener exceptionListener)

setThreadCreatedHandler

void setThreadCreatedHandler(ThreadCreatedHandler ml)

send

void send(Message message)
   throws DisconnectedException

Throws:

DisconnectedException

sendWithoutRetry

void sendWithoutRetry(Message message)
               throws DisconnectedException

Throws:

DisconnectedException

allocateMessage

Message allocateMessage()

writeQueueSize

long writeQueueSize()
             throws DisconnectedException

Throws:

DisconnectedException

readQueueSize

long readQueueSize()
            throws DisconnectedException

Throws:

DisconnectedException

flush

long flush()
    throws DisconnectedException

Throws:

DisconnectedException

flush

long flush(long timeout)
    throws DisconnectedException

Throws:

DisconnectedException

handleCloseEvent

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

Throws:

DisconnectedException

RetryOperationException

getVersion

int getVersion()

setReadTimeout

void setReadTimeout(int readTimeoutMillis_)

setTransportFilter

void setTransportFilter(TransportFilter filter_)

Sets a TransportFilter that filters raw bytes before send and after receive.

Parameters:

filter_ - A TransportFilter instance such as com.crankuptheamps.client.TransportTraceFilter.

getIdleRunnable

AMPSRunnable getIdleRunnable()

Gets the AMPSRunnable that is invoked during idle-time processing for this connection.

Returns:

The currently registered idle runnable or null.

setIdleRunnable

void setIdleRunnable(AMPSRunnable runnable)

Sets a AMPSRunnable that is invoked during idle-time processing for this connection.

Parameters:

runnable - A AMPSRunnable instance whose run() method is invoked.

initFromClient

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.

Parameters:

client - The Client that will be using the Transport.