Package org.cometd.client.websocket.common

Class AbstractWebSocketTransport

java.lang.Object

org.cometd.common.AbstractTransport

org.cometd.client.transport.ClientTransport

org.cometd.client.transport.HttpClientTransport

org.cometd.client.websocket.common.AbstractWebSocketTransport

All Implemented Interfaces:

Transport, MessageClientTransport

Direct Known Subclasses:

JettyWebSocketTransport, OkHttpWebSocketTransport, WebSocketTransport

public abstract class AbstractWebSocketTransport
extends HttpClientTransport
implements MessageClientTransport

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractWebSocketTransport.Delegate

Nested classes/interfaces inherited from class org.cometd.client.transport.ClientTransport

ClientTransport.Factory, ClientTransport.FailureHandler, ClientTransport.FailureInfo

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONNECT_TIMEOUT_OPTION
protected static final String	COOKIE_HEADER
static final String	IDLE_TIMEOUT_OPTION
static final int	MAX_CLOSE_REASON_LENGTH
static final String	NAME
static final int	NORMAL_CLOSE_CODE
static final String	PERMESSAGE_DEFLATE_OPTION
static final String	PREFIX
static final String	PROTOCOL_OPTION
static final String	STICKY_RECONNECT_OPTION

Fields inherited from class org.cometd.client.transport.ClientTransport

JSON_CONTEXT_OPTION, MAX_MESSAGE_SIZE_OPTION, MAX_NETWORK_DELAY_OPTION, MAX_SEND_BAYEUX_MESSAGE_SIZE_OPTION, SCHEDULER_OPTION, URL_OPTION

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractWebSocketTransport(String url, Map<String,Object> options, ScheduledExecutorService scheduler)

Method Summary

Modifier and Type	Method	Description
void	abort(Throwable failure)	Aborts this transport, usually by cancelling all pending Bayeux messages that require a response, such as /meta/connects, without waiting for a response.
protected abstract AbstractWebSocketTransport.Delegate	connect(String uri, TransportListener listener, List<Message.Mutable> messages)
long	getConnectTimeout()
protected AbstractWebSocketTransport.Delegate	getDelegate()
long	getIdleTimeout()
String	getProtocol()
void	init()
boolean	isPerMessageDeflateEnabled()
boolean	isStickyReconnect()
protected void	locked(Runnable block)
protected <T> T	locked(Supplier<T> block)
void	send(TransportListener listener, List<Message.Mutable> messages)
void	setMessageTransportListener(TransportListener listener)
void	setURL(String url)
void	terminate()	Terminates this transport, usually by closing network connections opened directly by this transport.

Methods inherited from class org.cometd.client.transport.HttpClientTransport

getCookies, getCookieStore, setCookieStore, storeCookies

Methods inherited from class org.cometd.client.transport.ClientTransport

accept, generateJSON, getJSONContextClient, getMaxNetworkDelay, getScheduler, getURL, initScheduler, parseMessages, setMaxNetworkDelay, shutdownScheduler

Methods inherited from class org.cometd.common.AbstractTransport

getName, getOption, getOption, getOption, getOption, getOption, getOptionNames, getOptionPrefix, setOption, setOptionPrefix

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

public static final String PREFIX

See Also:

• Constant Field Values

NAME

public static final String NAME

See Also:

• Constant Field Values

PROTOCOL_OPTION

public static final String PROTOCOL_OPTION

See Also:

• Constant Field Values

PERMESSAGE_DEFLATE_OPTION

public static final String PERMESSAGE_DEFLATE_OPTION

See Also:

• Constant Field Values

CONNECT_TIMEOUT_OPTION

public static final String CONNECT_TIMEOUT_OPTION

See Also:

• Constant Field Values

IDLE_TIMEOUT_OPTION

public static final String IDLE_TIMEOUT_OPTION

See Also:

• Constant Field Values

STICKY_RECONNECT_OPTION

public static final String STICKY_RECONNECT_OPTION

See Also:

• Constant Field Values

MAX_CLOSE_REASON_LENGTH

public static final int MAX_CLOSE_REASON_LENGTH

See Also:

• Constant Field Values

NORMAL_CLOSE_CODE

public static final int NORMAL_CLOSE_CODE

See Also:

• Constant Field Values

COOKIE_HEADER

protected static final String COOKIE_HEADER

See Also:

• Constant Field Values

Constructor Details

AbstractWebSocketTransport

protected AbstractWebSocketTransport(String url,
 Map<String,Object> options,
 ScheduledExecutorService scheduler)

Method Details

setMessageTransportListener

public void setMessageTransportListener(TransportListener listener)

Specified by:

setMessageTransportListener in interface MessageClientTransport

Parameters:

listener - the listener that handles unsolicited messages from the server

setURL

public void setURL(String url)

Overrides:

setURL in class ClientTransport

init

public void init()

Overrides:

init in class ClientTransport

locked

protected void locked(Runnable block)

locked

protected <T> T locked(Supplier<T> block)

getProtocol

public String getProtocol()

isPerMessageDeflateEnabled

public boolean isPerMessageDeflateEnabled()

getIdleTimeout

public long getIdleTimeout()

getConnectTimeout

public long getConnectTimeout()

isStickyReconnect

public boolean isStickyReconnect()

abort

public void abort(Throwable failure)

Description copied from class: ClientTransport

Aborts this transport, usually by cancelling all pending Bayeux messages that require a response, such as /meta/connects, without waiting for a response.

Specified by:

abort in class ClientTransport

Parameters:

failure - the cause of the abort

See Also:

• BayeuxClient.abort()

terminate

public void terminate()

Description copied from class: ClientTransport

Terminates this transport, usually by closing network connections opened directly by this transport.

Overrides:

terminate in class ClientTransport

See Also:

• ClientSession.disconnect()

getDelegate

protected AbstractWebSocketTransport.Delegate getDelegate()

send

public void send(TransportListener listener,
 List<Message.Mutable> messages)

Specified by:

send in class ClientTransport

connect

protected abstract AbstractWebSocketTransport.Delegate connect(String uri,
 TransportListener listener,
 List<Message.Mutable> messages)