Package org.cometd.bayeux

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.

Method Summary

Modifier and Type	Method	Description
List<String>	getAllowedTransports()
Set<String>	getKnownTransportNames()
Object	getOption(String qualifiedName)
Set<String>	getOptionNames()
Transport	getTransport(String transport)
void	setOption(String qualifiedName, Object value)

Method Detail

getKnownTransportNames

Set<String> getKnownTransportNames()

Returns:

the set of known transport names of this Bayeux object.

See Also:

getAllowedTransports()

getTransport

Transport getTransport(String transport)

Parameters:

transport - the transport name

Returns:

the transport with the given name or null if no such transport exist

getAllowedTransports

List<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

Object getOption(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(String qualifiedName,
               Object value)

Parameters:

qualifiedName - the configuration option name

value - the configuration option value

See Also:

getOption(String)

getOptionNames

Set<String> getOptionNames()

Returns:

the set of configuration options

See Also:

getOption(String)