org.granite.client.messaging.transport

Class AbstractTransport<C>

java.lang.Object

org.granite.client.messaging.transport.AbstractTransport<C>

All Implemented Interfaces:

Transport

Direct Known Subclasses:

AbstractWebSocketTransport, ApacheAsyncTransport

public abstract class AbstractTransport<C>
extends java.lang.Object
implements Transport

Author:

Franck WOLFF

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<TransportStopListener>	stopListeners

Constructor Summary

Constructors

Constructor and Description
AbstractTransport()
AbstractTransport(C context)

Method Summary

Methods

Modifier and Type	Method and Description
void	addStopListener(TransportStopListener listener) Register a stop listener for this transport
C	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	removeStopListener(TransportStopListener listener) Unregister a stop listener for this transport
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
void	stop() Stop the transport and stop any communication on the network

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.granite.client.messaging.transport.Transport

isReconnectAfterReceive, isStarted, send, start

Field Detail

stopListeners

protected final java.util.List<TransportStopListener> stopListeners

Constructor Detail

AbstractTransport

public AbstractTransport()

AbstractTransport

public AbstractTransport(C context)

Method Detail

setContext

public void setContext(java.lang.Object context)

Description copied from interface: Transport

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

Specified by:

setContext in interface Transport

Parameters:

context - current context

getContext

public C getContext()

Description copied from interface: Transport

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

Specified by:

getContext in interface Transport

Returns:

current context

isDisconnectAfterAuthenticationFailure

public boolean isDisconnectAfterAuthenticationFailure()

Description copied from interface: Transport

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

Specified by:

isDisconnectAfterAuthenticationFailure in interface Transport

Returns:

true if the transport should close

setStatusHandler

public void setStatusHandler(TransportStatusHandler statusHandler)

Description copied from interface: Transport

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

Specified by:

setStatusHandler in interface Transport

Parameters:

statusHandler - status handler

See Also:

TransportStatusHandler

getStatusHandler

public TransportStatusHandler getStatusHandler()

Description copied from interface: Transport

Get the status handler for this transport

Specified by:

getStatusHandler in interface Transport

Returns:

current status handler

See Also:

TransportStatusHandler

addStopListener

public void addStopListener(TransportStopListener listener)

Description copied from interface: Transport

Register a stop listener for this transport

Specified by:

addStopListener in interface Transport

Parameters:

listener - stop listener

See Also:

TransportStopListener

removeStopListener

public boolean removeStopListener(TransportStopListener listener)

Description copied from interface: Transport

Unregister a stop listener for this transport

Specified by:

removeStopListener in interface Transport

Parameters:

listener - stop listener

Returns:

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

See Also:

TransportStopListener

stop

public void stop()

Description copied from interface: Transport

Stop the transport and stop any communication on the network

Specified by:

stop in interface Transport