AbstractServerTransport (CometD

java.lang.Object
- org.cometd.common.AbstractTransport
- - org.cometd.server.AbstractServerTransport

All Implemented Interfaces:

ServerTransport, Transport, org.eclipse.jetty.util.component.Dumpable

Direct Known Subclasses:

AbstractHttpTransport, AbstractWebSocketTransport
```
public abstract class AbstractServerTransport
extends AbstractTransport
implements ServerTransport, org.eclipse.jetty.util.component.Dumpable
```
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` Performs server-to-client transport operations when a `/meta/connect` message is held and a server-side message is published.

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable
org.eclipse.jetty.util.component.Dumpable.DumpableContainer

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALLOW_MESSAGE_DELIVERY_DURING_HANDSHAKE`
`static String`	`HANDSHAKE_RECONNECT_OPTION`
`static String`	`INTERVAL_OPTION`
`static String`	`JSON_CONTEXT_OPTION`
`static String`	`MAX_INTERVAL_OPTION`
`static String`	`MAX_LAZY_TIMEOUT_OPTION`
`static String`	`MAX_MESSAGE_SIZE_OPTION`
`static String`	`MAX_PROCESSING_OPTION`
`static String`	`MAX_QUEUE_OPTION`
`static String`	`META_CONNECT_DELIVERY_OPTION`
`static String`	`TIMEOUT_OPTION`

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable
KEY

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`allowMessageDeliveryDuringHandshake(ServerSessionImpl session)`
`void`	`destroy()`
`void`	`dump(Appendable out, String indent)`
`BayeuxServerImpl`	`getBayeux()`
`long`	`getInterval()`
`protected JSONContextServer`	`getJSONContextServer()`
`long`	`getMaxInterval()`
`long`	`getMaxLazyTimeout()`
`int`	`getMaxMessageSize()`
`long`	`getTimeout()`
`void`	`init()` Initializes the transport, resolving default and direct options.
`boolean`	`isAllowMessageDeliveryDuringHandshake()`
`boolean`	`isHandshakeReconnect()`
`boolean`	`isMetaConnectDeliveryOnly()`
`long`	`newMetaConnectCycle()`
`protected ServerMessage.Mutable[]`	`parseMessages(BufferedReader reader, boolean jsonDebug)`
`ServerMessage.Mutable[]`	`parseMessages(String json)`
`void`	`processReply(ServerSessionImpl session, ServerMessage.Mutable reply, Promise<ServerMessage.Mutable> promise)`
`void`	`scheduleExpiration(ServerSessionImpl session, long metaConnectCycle)`
`void`	`setAllowMessageDeliveryDuringHandshake(boolean allow)`
`void`	`setHandshakeReconnect(boolean handshakeReconnect)`
`void`	`setInterval(long interval)`
`void`	`setMaxInterval(long maxInterval)`
`void`	`setMaxLazyTimeout(long maxLazyTimeout)`
`void`	`setMaxMessageSize(int maxMessageSize)`
`void`	`setMetaConnectDeliveryOnly(boolean meta)`
`void`	`setTimeout(long timeout)`
`protected void`	`sweep()` Housekeeping sweep, called a regular intervals
`protected String`	`toJSON(ServerMessage msg)`
`String`	`toString()`

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, wait, wait, wait

Methods inherited from interface org.cometd.bayeux.Transport
getName, getOption, getOptionNames, getOptionPrefix

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable
dump, dump, dumpContainer, dumpIterable, dumpMapEntries, dumpObject, dumpObjects, dumpSelf, named

- 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_PROCESSING_OPTION
```
public static final String MAX_PROCESSING_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
  - HANDSHAKE_RECONNECT_OPTION
```
public static final String HANDSHAKE_RECONNECT_OPTION
```
    See Also:
    
    Constant Field Values
  - ALLOW_MESSAGE_DELIVERY_DURING_HANDSHAKE
```
public static final String ALLOW_MESSAGE_DELIVERY_DURING_HANDSHAKE
```
    See Also:
    
    Constant Field Values
  - MAX_MESSAGE_SIZE_OPTION
```
public static final String MAX_MESSAGE_SIZE_OPTION
```
    See Also:
    
    Constant Field Values
- 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
  - newMetaConnectCycle
```
public long newMetaConnectCycle()
```
  - 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
    
    Returns:
    
    whether the messages are delivered to clients exclusively via the "/meta/connect" channel
  - setMetaConnectDeliveryOnly
```
public void setMetaConnectDeliveryOnly(boolean meta)
```
  - isHandshakeReconnect
```
public boolean isHandshakeReconnect()
```
  - setHandshakeReconnect
```
public void setHandshakeReconnect(boolean handshakeReconnect)
```
  - isAllowMessageDeliveryDuringHandshake
```
public boolean isAllowMessageDeliveryDuringHandshake()
```
  - setAllowMessageDeliveryDuringHandshake
```
public void setAllowMessageDeliveryDuringHandshake(boolean allow)
```
  - getMaxMessageSize
```
public int getMaxMessageSize()
```
  - setMaxMessageSize
```
public void setMaxMessageSize(int maxMessageSize)
```
  - init
```
public void init()
```
    Initializes the transport, resolving default and direct options.
  - destroy
```
public void destroy()
```
  - getJSONContextServer
```
protected JSONContextServer getJSONContextServer()
```
  - parseMessages
```
protected ServerMessage.Mutable[] parseMessages(BufferedReader reader,
                                                boolean jsonDebug)
                                         throws ParseException,
                                                IOException
```
    Throws:
    
    ParseException
    
    IOException
  - parseMessages
```
public 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
  - processReply
```
public void processReply(ServerSessionImpl session,
                         ServerMessage.Mutable reply,
                         Promise<ServerMessage.Mutable> promise)
```
  - toJSON
```
protected String toJSON(ServerMessage msg)
```
  - allowMessageDeliveryDuringHandshake
```
public boolean allowMessageDeliveryDuringHandshake(ServerSessionImpl session)
```
  - scheduleExpiration
```
public void scheduleExpiration(ServerSessionImpl session,
                               long metaConnectCycle)
```
  - dump
```
public void dump(Appendable out,
                 String indent)
          throws IOException
```
    Specified by:
    
    dump in interface org.eclipse.jetty.util.component.Dumpable
    
    Throws:
    
    IOException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AbstractServerTransport

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

Field Summary

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

Constructor Summary

Method Summary

Methods inherited from class org.cometd.common.AbstractTransport

Methods inherited from class java.lang.Object

Methods inherited from interface org.cometd.bayeux.Transport

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

Field Detail

TIMEOUT_OPTION

INTERVAL_OPTION

MAX_INTERVAL_OPTION

MAX_PROCESSING_OPTION

MAX_LAZY_TIMEOUT_OPTION

META_CONNECT_DELIVERY_OPTION

MAX_QUEUE_OPTION

JSON_CONTEXT_OPTION

HANDSHAKE_RECONNECT_OPTION

ALLOW_MESSAGE_DELIVERY_DURING_HANDSHAKE

MAX_MESSAGE_SIZE_OPTION

Constructor Detail

AbstractServerTransport

Method Detail

newMetaConnectCycle

getInterval

getMaxInterval

getMaxLazyTimeout

getTimeout

isMetaConnectDeliveryOnly

setMetaConnectDeliveryOnly

isHandshakeReconnect

setHandshakeReconnect

isAllowMessageDeliveryDuringHandshake

setAllowMessageDeliveryDuringHandshake

getMaxMessageSize

setMaxMessageSize

init

destroy

getJSONContextServer

parseMessages

parseMessages

getBayeux

setInterval

setMaxInterval

setTimeout

setMaxLazyTimeout

sweep

processReply

toJSON

allowMessageDeliveryDuringHandshake

scheduleExpiration

dump

toString