org.fusesource.hawtdispatch.transport
Interface Transport

All Known Subinterfaces:

SecureTransport

All Known Implementing Classes:

PipeTransport, SslTransport, TcpTransport, UdpTransport

public interface Transport

Represents an abstract connection. It can be a client side or server side connection.

Author:

Hiram Chirino

Method Summary

void	flush() Forces a flush of any output buffers.
boolean	full()
DispatchQueue	getDispatchQueue() Returns the dispatch queue used by the transport
SocketAddress	getLocalAddress()
ProtocolCodec	getProtocolCodec()
SocketAddress	getRemoteAddress()
TransportListener	getTransportListener() Returns the current transport listener
boolean	isClosed()
boolean	isConnected()
boolean	offer(Object command) A one way asynchronous send of a command.
void	resumeRead() resume delivery of commands.
void	setDispatchQueue(DispatchQueue queue) Sets the dispatch queue used by the transport
void	setProtocolCodec(ProtocolCodec protocolCodec) Sets the protocol codec for the transport
void	setTransportListener(TransportListener transportListener) Registers an inbound command listener
void	start(Runnable onComplete) Deprecated.
void	start(Task onComplete) Starts the service.
void	stop(Runnable onComplete) Deprecated.
void	stop(Task onComplete) Stops the service.
void	suspendRead() suspend delivery of commands.

Method Detail

start

@Deprecated
void start(Runnable onComplete)

Deprecated.

Starts the service. Executes the onComplete runnable once the service has fully started up.

Parameters:

onComplete - my be set to null if not interested in a callback.

stop

@Deprecated
void stop(Runnable onComplete)

Deprecated.

Stops the service. Executes the onComplete runnable once the service has fully stopped.

Parameters:

onComplete - my be set to null if not interested in a callback.

start

void start(Task onComplete)

Starts the service. Executes the onComplete runnable once the service has fully started up.

Parameters:

onComplete - my be set to null if not interested in a callback.

stop

void stop(Task onComplete)

Stops the service. Executes the onComplete runnable once the service has fully stopped.

Parameters:

onComplete - my be set to null if not interested in a callback.

full

boolean full()

offer

boolean offer(Object command)

A one way asynchronous send of a command. Only sent if the the transport is not full.

Parameters:

command -

Returns:

true if the command was accepted.

flush

void flush()

Forces a flush of any output buffers. Once the flush completes the listener's 'onRefill()' method will execute.

getTransportListener

TransportListener getTransportListener()

Returns the current transport listener

Returns:

setTransportListener

void setTransportListener(TransportListener transportListener)

Registers an inbound command listener

Parameters:

transportListener -

getDispatchQueue

DispatchQueue getDispatchQueue()

Returns the dispatch queue used by the transport

Returns:

setDispatchQueue

void setDispatchQueue(DispatchQueue queue)

Sets the dispatch queue used by the transport

Parameters:

queue -

suspendRead

void suspendRead()

suspend delivery of commands.

resumeRead

void resumeRead()

resume delivery of commands.

getRemoteAddress

SocketAddress getRemoteAddress()

Returns:

the remote address for this connection

getLocalAddress

SocketAddress getLocalAddress()

Returns:

the remote address for this connection

isClosed

boolean isClosed()

Returns:

true if the transport is closed/stopped.

isConnected

boolean isConnected()

Returns:

true if the transport is connected

getProtocolCodec

ProtocolCodec getProtocolCodec()

Returns:

The protocol codec for the transport.

setProtocolCodec

void setProtocolCodec(ProtocolCodec protocolCodec)
                      throws Exception

Sets the protocol codec for the transport

Parameters:

protocolCodec -

Throws:

Exception