Interface Bayeux

All Known Subinterfaces:
BayeuxServer
All Known Implementing Classes:
BayeuxClient, BayeuxServerImpl, OortComet

public interface Bayeux

The Bayeux interface is the common API for both client-side and server-side configuration and usage of the Bayeux object.

The Bayeux object handles configuration options and a set of transports that is negotiated with the server.

See Also:
Transport
  • Nested Class Summary

    Nested Classes
    Modifier and Type Interface Description
    static interface  Bayeux.BayeuxListener
    The common base interface for Bayeux listeners.
    static class  Bayeux.Validator
    Validates Bayeux protocol elements such as channel ids and message ids.
  • Method Summary

    Modifier and Type Method Description
    java.util.List<java.lang.String> getAllowedTransports()  
    java.util.Set<java.lang.String> getKnownTransportNames()  
    java.lang.Object getOption​(java.lang.String qualifiedName)  
    java.util.Set<java.lang.String> getOptionNames()  
    Transport getTransport​(java.lang.String transport)  
    void setOption​(java.lang.String qualifiedName, java.lang.Object value)  
  • Method Details

    • getKnownTransportNames

      java.util.Set<java.lang.String> getKnownTransportNames()
      Returns:
      the set of known transport names of this Bayeux object.
      See Also:
      getAllowedTransports()
    • getTransport

      Transport getTransport​(java.lang.String transport)
      Parameters:
      transport - the transport name
      Returns:
      the transport with the given name or null if no such transport exist
    • getAllowedTransports

      java.util.List<java.lang.String> getAllowedTransports()
      Returns:
      the ordered list of transport names that will be used in the negotiation of transports with the other peer.
      See Also:
      getKnownTransportNames()
    • getOption

      java.lang.Object getOption​(java.lang.String qualifiedName)
      Parameters:
      qualifiedName - the configuration option name
      Returns:
      the configuration option with the given qualifiedName
      See Also:
      setOption(String, Object), getOptionNames()
    • setOption

      void setOption​(java.lang.String qualifiedName, java.lang.Object value)
      Parameters:
      qualifiedName - the configuration option name
      value - the configuration option value
      See Also:
      getOption(String)
    • getOptionNames

      java.util.Set<java.lang.String> getOptionNames()
      Returns:
      the set of configuration options
      See Also:
      getOption(String)