org.cometd.server

Class AbstractServerTransport

java.lang.Object

org.cometd.common.AbstractTransport

org.cometd.server.AbstractServerTransport

All Implemented Interfaces:

ServerTransport, Transport

Direct Known Subclasses:

AbstractHttpTransport

public abstract class AbstractServerTransport
extends AbstractTransport
implements ServerTransport

The base class of all server transports.

Each derived Transport class should declare all options that it supports by calling AbstractTransport.setOption(String, Object) for each option. Then during the call the init(), each transport should call the variants of AbstractTransport.getOption(String) to obtained the configured value for the option.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractServerTransport.Scheduler

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	_logger
static String	INTERVAL_OPTION
static String	JSON_CONTEXT_OPTION
static String	MAX_INTERVAL_OPTION
static String	MAX_LAZY_TIMEOUT_OPTION
static String	MAX_QUEUE_OPTION
static String	META_CONNECT_DELIVERY_OPTION
static String	TIMEOUT_OPTION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractServerTransport(BayeuxServerImpl bayeux, String name) The constructor is passed the BayeuxServerImpl instance for the transport.

Method Summary

Modifier and Type	Method and Description
void	destroy()
Object	getAdvice()
BayeuxServerImpl	getBayeux()
long	getInterval()
long	getMaxInterval()
long	getMaxLazyTimeout()
long	getTimeout()
void	init() Initializes the transport, resolving default and direct options.
boolean	isMetaConnectDeliveryOnly()
protected ServerMessage.Mutable[]	parseMessages(BufferedReader reader, boolean jsonDebug)
protected ServerMessage.Mutable[]	parseMessages(String json)
void	setInterval(long interval)
void	setMaxInterval(long maxInterval)
void	setMaxLazyTimeout(long maxLazyTimeout)
void	setMetaConnectDeliveryOnly(boolean meta)
void	setTimeout(long timeout)
protected void	sweep() Housekeeping sweep, called a regular intervals
protected byte[]	toJSONBytes(ServerMessage message, String encoding)

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

Methods inherited from interface org.cometd.bayeux.server.ServerTransport

getContext

Methods inherited from interface org.cometd.bayeux.Transport

getName, getOption, getOptionNames, getOptionPrefix

Field Detail

TIMEOUT_OPTION

public static final String TIMEOUT_OPTION

See Also:

Constant Field Values

INTERVAL_OPTION

public static final String INTERVAL_OPTION

See Also:

Constant Field Values

MAX_INTERVAL_OPTION

public static final String MAX_INTERVAL_OPTION

See Also:

Constant Field Values

MAX_LAZY_TIMEOUT_OPTION

public static final String MAX_LAZY_TIMEOUT_OPTION

See Also:

Constant Field Values

META_CONNECT_DELIVERY_OPTION

public static final String META_CONNECT_DELIVERY_OPTION

See Also:

Constant Field Values

MAX_QUEUE_OPTION

public static final String MAX_QUEUE_OPTION

See Also:

Constant Field Values

JSON_CONTEXT_OPTION

public static final String JSON_CONTEXT_OPTION

See Also:

Constant Field Values

_logger

protected final org.slf4j.Logger _logger

Constructor Detail

AbstractServerTransport

protected AbstractServerTransport(BayeuxServerImpl bayeux,
                                  String name)

The constructor is passed the BayeuxServerImpl instance for the transport. The BayeuxServerImpl.getOptions() map is populated with the default options known by this transport. The options are then inspected again when init() is called, to set the actual values used. The options are arranged into a naming hierarchy by derived classes adding prefix by calling add AbstractTransport.setOptionPrefix(String). Calls to AbstractTransport.getOption(String) will use the list of prefixes to search for the most specific option set.

Parameters:

bayeux - the BayeuxServer implementation

name - the name of the transport

Method Detail

getAdvice

public Object getAdvice()

Specified by:

getAdvice in interface ServerTransport

getInterval

public long getInterval()

Specified by:

getInterval in interface ServerTransport

Returns:

the interval in milliseconds

getMaxInterval

public long getMaxInterval()

Specified by:

getMaxInterval in interface ServerTransport

Returns:

the maxInterval in milliseconds

getMaxLazyTimeout

public long getMaxLazyTimeout()

Specified by:

getMaxLazyTimeout in interface ServerTransport

Returns:

the max lazy timeout in milliseconds before flushing lazy messages

getTimeout

public long getTimeout()

Specified by:

getTimeout in interface ServerTransport

Returns:

the timeout in milliseconds

isMetaConnectDeliveryOnly

public boolean isMetaConnectDeliveryOnly()

Specified by:

isMetaConnectDeliveryOnly in interface ServerTransport

setMetaConnectDeliveryOnly

public void setMetaConnectDeliveryOnly(boolean meta)

init

public void init()

Initializes the transport, resolving default and direct options.

destroy

public void destroy()

parseMessages

protected ServerMessage.Mutable[] parseMessages(BufferedReader reader,
                                                boolean jsonDebug)
                                         throws ParseException,
                                                IOException

Throws:

ParseException

IOException

parseMessages

protected ServerMessage.Mutable[] parseMessages(String json)
                                         throws ParseException

Throws:

ParseException

getBayeux

public BayeuxServerImpl getBayeux()

Returns:

the BayeuxServer object

setInterval

public void setInterval(long interval)

Parameters:

interval - the interval in milliseconds

setMaxInterval

public void setMaxInterval(long maxInterval)

Parameters:

maxInterval - the maxInterval in milliseconds

setTimeout

public void setTimeout(long timeout)

Parameters:

timeout - the timeout in milliseconds

setMaxLazyTimeout

public void setMaxLazyTimeout(long maxLazyTimeout)

Parameters:

maxLazyTimeout - the maxLazyTimeout in milliseconds

sweep

protected void sweep()

Housekeeping sweep, called a regular intervals

toJSONBytes

protected byte[] toJSONBytes(ServerMessage message,
                             String encoding)