org.granite.client.messaging.transport

Interface Transport

All Known Implementing Classes:

AbstractTransport, AbstractWebSocketTransport, ApacheAsyncTransport, JettyStdWebSocketTransport, JettyWebSocketTransport, JettyWebSocketTransport, TyrusWebSocketTransport, WebSocketTransport

public interface Transport

Transport is a SPI describing a communication layer handling a low-level network protocol It is used by a Channel to actually transmit the messages to or from the remote server Usually transports are implicitly defined for the current Platform and created internally by a ChannelFactory but it's possible to define custom transport and register them

Author:

Franck WOLFF

Method Summary

Methods

Modifier and Type	Method and Description
void	addStopListener(TransportStopListener listener) Register a stop listener for this transport
java.lang.Object	getContext() The generic context object for this transport (actual type of the context depends on the Platform)
TransportStatusHandler	getStatusHandler() Get the status handler for this transport
boolean	isDisconnectAfterAuthenticationFailure() Indicates to the calling Channel that the transport should be closed after an authentication failure
boolean	isReconnectAfterReceive() Indicates to the calling Channel that the transport should reconnect when data has been received
boolean	isStarted() Is the transport started ?
boolean	removeStopListener(TransportStopListener listener) Unregister a stop listener for this transport
TransportFuture	send(Channel channel, TransportMessage message) Send a message on the network
void	setContext(java.lang.Object context) Set the current context for this transport (usually depends on the Platform)
void	setStatusHandler(TransportStatusHandler statusHandler) Attach a status handler that will be notified of network activity and errors
boolean	start() Start the transport and enable transmission of data on the network If there is an exception during start, the status handler is notified TransportStatusHandler.handleException(org.granite.client.messaging.transport.TransportException)
void	stop() Stop the transport and stop any communication on the network

Method Detail

setContext

void setContext(java.lang.Object context)

Set the current context for this transport (usually depends on the Platform)

Parameters:

context - current context

getContext

java.lang.Object getContext()

The generic context object for this transport (actual type of the context depends on the Platform)

Returns:

current context

start

boolean start()

Start the transport and enable transmission of data on the network If there is an exception during start, the status handler is notified TransportStatusHandler.handleException(org.granite.client.messaging.transport.TransportException)

Returns:

true if correctly started, false if the transport could not start

isStarted

boolean isStarted()

Is the transport started ?

Returns:

true if started

stop

void stop()

Stop the transport and stop any communication on the network

isReconnectAfterReceive

boolean isReconnectAfterReceive()

Indicates to the calling Channel that the transport should reconnect when data has been received

Returns:

true if the transport should reconnect

isDisconnectAfterAuthenticationFailure

boolean isDisconnectAfterAuthenticationFailure()

Indicates to the calling Channel that the transport should be closed after an authentication failure

Returns:

true if the transport should close

setStatusHandler

void setStatusHandler(TransportStatusHandler statusHandler)

Attach a status handler that will be notified of network activity and errors

Parameters:

statusHandler - status handler

See Also:

TransportStatusHandler

getStatusHandler

TransportStatusHandler getStatusHandler()

Get the status handler for this transport

Returns:

current status handler

See Also:

TransportStatusHandler

addStopListener

void addStopListener(TransportStopListener listener)

Register a stop listener for this transport

Parameters:

listener - stop listener

See Also:

TransportStopListener

removeStopListener

boolean removeStopListener(TransportStopListener listener)

Unregister a stop listener for this transport

Parameters:

listener - stop listener

Returns:

true if the listener was unregistered, false if it was not present

See Also:

TransportStopListener

send

TransportFuture send(Channel channel,
                   TransportMessage message)
                     throws TransportException

Send a message on the network

Parameters:

channel - originating channel

message - message to send

Returns:

future object that will be triggered asynchronously when the message is sent

Throws:

TransportException - when an error occurs during send