org.granite.client.messaging.transport.websocket

Class WebSocketTransport

java.lang.Object

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

org.granite.client.messaging.transport.websocket.AbstractWebSocketTransport<javax.websocket.Session>

org.granite.client.messaging.transport.websocket.WebSocketTransport

All Implemented Interfaces:

Transport

Direct Known Subclasses:

JettyStdWebSocketTransport, TyrusWebSocketTransport

public abstract class WebSocketTransport
extends AbstractWebSocketTransport<javax.websocket.Session>

Author:

William DRAI

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	WebSocketTransport.GravityWebSocketEndpoint
class	WebSocketTransport.GravityWebSocketEndpointConfig

Nested classes/interfaces inherited from class org.granite.client.messaging.transport.websocket.AbstractWebSocketTransport

AbstractWebSocketTransport.TransportData<S>

Field Summary

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

stopListeners

Constructor Summary

Constructors

Constructor and Description
WebSocketTransport()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	closeContainer(javax.websocket.WebSocketContainer webSocketContainer)
void	connect(Channel channel, TransportMessage transportMessage)
protected abstract javax.websocket.WebSocketContainer	createContainer()
boolean	isStarted() Is the transport started ?
protected AbstractWebSocketTransport.TransportData<javax.websocket.Session>	newTransportData()
void	setUserProperties(java.util.Map<java.lang.String,java.lang.Object> userProperties)
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

Methods inherited from class org.granite.client.messaging.transport.websocket.AbstractWebSocketTransport

getMaxIdleTime, getMaxMessageSize, isDisconnectAfterAuthenticationFailure, isReconnectAfterReceive, onBinaryMessage, onClose, onConnect, onError, send, setMaxIdleTime, setMaxMessageSize, setPingDelay, setReconnectIntervalMillis, setStopping

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

addStopListener, getContext, getStatusHandler, removeStopListener, setContext, setStatusHandler

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketTransport

public WebSocketTransport()

Method Detail

setUserProperties

public void setUserProperties(java.util.Map<java.lang.String,java.lang.Object> userProperties)

start

public boolean start()

Description copied from interface: Transport

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

createContainer

protected abstract javax.websocket.WebSocketContainer createContainer()

closeContainer

protected abstract void closeContainer(javax.websocket.WebSocketContainer webSocketContainer)

isStarted

public boolean isStarted()

Description copied from interface: Transport

Is the transport started ?

Returns:

true if started

connect

public void connect(Channel channel,
           TransportMessage transportMessage)

Specified by:

connect in class AbstractWebSocketTransport<javax.websocket.Session>

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

Overrides:

stop in class AbstractTransport<java.lang.Object>

newTransportData

protected AbstractWebSocketTransport.TransportData<javax.websocket.Session> newTransportData()

Specified by:

newTransportData in class AbstractWebSocketTransport<javax.websocket.Session>