org.granite.client.messaging.transport.websocket

Class AbstractWebSocketTransport<S>

java.lang.Object

org.granite.client.messaging.transport.AbstractTransport<java.lang.Object>

org.granite.client.messaging.transport.websocket.AbstractWebSocketTransport<S>

All Implemented Interfaces:

Transport

Direct Known Subclasses:

JettyWebSocketTransport, JettyWebSocketTransport, WebSocketTransport

public abstract class AbstractWebSocketTransport<S>
extends AbstractTransport<java.lang.Object>

Author:

William DRAI

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractWebSocketTransport.TransportData<S>

Field Summary

Fields inherited from class org.granite.client.messaging.transport.AbstractTransport

stopListeners

Constructor Summary

Constructors

Constructor and Description
AbstractWebSocketTransport()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	connect(Channel channel, TransportMessage transportMessage)
int	getMaxIdleTime()
int	getMaxMessageSize()
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
protected abstract AbstractWebSocketTransport.TransportData<S>	newTransportData()
protected void	onBinaryMessage(Channel channel, byte[] data, int offset, int length)
protected void	onClose(Channel channel, int closeCode, java.lang.String message)
protected void	onConnect(Channel channel, S connection)
protected void	onError(Channel channel, java.lang.Throwable throwable)
TransportFuture	send(Channel channel, TransportMessage message) Send a message on the network
void	setMaxIdleTime(int maxIdleTime)
void	setMaxMessageSize(int maxMessageSize)
void	setPingDelay(int pingDelay)
void	setReconnectIntervalMillis(int reconnectIntervalMillis)
protected void	setStopping(boolean stopping)

Methods inherited from class org.granite.client.messaging.transport.AbstractTransport

addStopListener, getContext, getStatusHandler, removeStopListener, setContext, setStatusHandler, stop

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

isStarted, start

Constructor Detail

AbstractWebSocketTransport

public AbstractWebSocketTransport()

Method Detail

setMaxIdleTime

public void setMaxIdleTime(int maxIdleTime)

getMaxIdleTime

public int getMaxIdleTime()

setPingDelay

public void setPingDelay(int pingDelay)

setReconnectIntervalMillis

public void setReconnectIntervalMillis(int reconnectIntervalMillis)

isReconnectAfterReceive

public boolean isReconnectAfterReceive()

Description copied from interface: Transport

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

Returns:

true if the transport should reconnect

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

Overrides:

isDisconnectAfterAuthenticationFailure in class AbstractTransport<java.lang.Object>

Returns:

true if the transport should close

setMaxMessageSize

public void setMaxMessageSize(int maxMessageSize)

getMaxMessageSize

public int getMaxMessageSize()

send

public TransportFuture send(Channel channel,
                   TransportMessage message)

Description copied from interface: Transport

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

newTransportData

protected abstract AbstractWebSocketTransport.TransportData<S> newTransportData()

connect

public abstract void connect(Channel channel,
           TransportMessage transportMessage)

setStopping

protected void setStopping(boolean stopping)

onConnect

protected void onConnect(Channel channel,
             S connection)

onBinaryMessage

protected void onBinaryMessage(Channel channel,
                   byte[] data,
                   int offset,
                   int length)

onClose

protected void onClose(Channel channel,
           int closeCode,
           java.lang.String message)

onError

protected void onError(Channel channel,
           java.lang.Throwable throwable)