Package org.cometd.bayeux.server

Interface ServerTransport

All Superinterfaces:
Transport
All Known Implementing Classes:
AbstractHttpTransport, AbstractServerTransport, AbstractStreamHttpTransport, AbstractWebSocketTransport, AsyncJSONTransport, JettyWebSocketTransport, JSONPTransport, JSONTransport, WebSocketTransport
public interface ServerTransport
extends Transport

Server side extension of a Bayeux transport.

A ServerTransport can be configured with a timeout (that in the default long polling http transport is the period of time the server waits before answering to a long poll), an interval (that in the default long polling http transport is the period of time that the client waits between long polls), a maximum interval (that in the default long polling http transport is the period of time that must elapse before the server consider the client being lost).

Further configuration include the maximum lazy timeout used for lazy messages and the style of delivery, that may happen during both responses to requests and via the "/meta/connect" channel, or via the "/meta/connect" channel exclusively.

  • Method Details

    • getAdvice

      @Deprecated Object getAdvice()
      Deprecated.

      The advice that this transport sends to inform the client about transport (re)connection.

      Returns:
      the advice object sent by the server transport

    • getTimeout

      long getTimeout()
      Returns:
      the timeout (in milliseconds) of this transport

    • getInterval

      long getInterval()
      Returns:
      the interval of time (in milliseconds) of this transport

    • getMaxInterval

      long getMaxInterval()
      Returns:
      the maximum interval of time (in milliseconds) before the server consider the client lost

    • getMaxLazyTimeout

      long getMaxLazyTimeout()
      Returns:
      the maximum time (in milliseconds) before dispatching lazy messages

    • isMetaConnectDeliveryOnly

      boolean isMetaConnectDeliveryOnly()
      Returns:
      whether the messages are delivered to clients exclusively via the "/meta/connect" channel

    • getContext

      BayeuxContext getContext()
      Returns:
      The current transport context or null if no current context