Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- ADVICE_FIELD - Static variable in interface org.cometd.bayeux.Message
- asByteBuffer() - Method in class org.cometd.bayeux.BinaryData
- asBytes() - Method in class org.cometd.bayeux.BinaryData
B
- batch(Runnable) - Method in interface org.cometd.bayeux.Session
-
Executes the given command in a batch so that any Bayeux message sent by the command (via the Bayeux API) is queued up until the end of the command and then all messages are sent at once.
- Bayeux - Interface in org.cometd.bayeux
-
The
Bayeux
interface is the common API for both client-side and server-side configuration and usage of the Bayeux object. - Bayeux.BayeuxListener - Interface in org.cometd.bayeux
-
The common base interface for Bayeux listeners.
- Bayeux.Validator - Class in org.cometd.bayeux
-
Validates Bayeux protocol elements such as channel ids and message ids.
- BinaryData - Class in org.cometd.bayeux
-
Reified representation of binary data chunk contained in a message.
- BinaryData(byte[], boolean, Map<String, Object>) - Constructor for class org.cometd.bayeux.BinaryData
- BinaryData(ByteBuffer, boolean, Map<String, Object>) - Constructor for class org.cometd.bayeux.BinaryData
- BinaryData(Map<? extends String, ?>) - Constructor for class org.cometd.bayeux.BinaryData
- bind(ChannelId) - Method in class org.cometd.bayeux.ChannelId
-
If this
ChannelId
is a template, and the giventarget
ChannelId
is non-wild and non-template, and the two have the sameChannelId.depth()
, then binds the variable(s) defined in this template with the values of the segments defined by the targetChannelId
.
C
- Channel - Interface in org.cometd.bayeux
-
A Bayeux channel is the primary message routing mechanism within Bayeux: both Bayeux clients and Bayeux server use channels to group listeners that are interested in receiving messages with that channel.
- CHANNEL_FIELD - Static variable in interface org.cometd.bayeux.Message
- ChannelId - Class in org.cometd.bayeux
-
Reification of a
channel id
with methods to test properties and compare with otherChannelId
s. - ChannelId(String) - Constructor for class org.cometd.bayeux.ChannelId
-
Constructs a new
ChannelId
with the given id - CLIENT_ID_FIELD - Static variable in interface org.cometd.bayeux.Message
- Completable() - Constructor for class org.cometd.bayeux.Promise.Completable
- complete() - Method in interface org.cometd.bayeux.Promise
-
Returns a
BiConsumer
that, when invoked, completes this Promise. - complete(BiConsumer<T, Throwable>) - Static method in interface org.cometd.bayeux.Promise
-
Returns a Promise that, when completed, invokes the given
BiConsumer
function. - CONNECTION_TYPE_FIELD - Static variable in interface org.cometd.bayeux.Message
D
- DATA - Static variable in class org.cometd.bayeux.BinaryData
- DATA_FIELD - Static variable in interface org.cometd.bayeux.Message
- DEEPWILD - Static variable in class org.cometd.bayeux.ChannelId
- depth() - Method in class org.cometd.bayeux.ChannelId
- disconnect() - Method in interface org.cometd.bayeux.Session
-
Disconnects this session, ending the link between the client and the server peers.
E
- empty() - Static method in class org.cometd.bayeux.MarkedReference
- endBatch() - Method in interface org.cometd.bayeux.Session
-
Ends a batch started with
startBatch()
. - equals(Object) - Method in class org.cometd.bayeux.ChannelId
- ERROR_FIELD - Static variable in interface org.cometd.bayeux.Message
- EXT_FIELD - Static variable in interface org.cometd.bayeux.Message
- EXT_NAME - Static variable in class org.cometd.bayeux.BinaryData
F
- fail(Throwable) - Method in class org.cometd.bayeux.Promise.Completable
- fail(Throwable) - Method in interface org.cometd.bayeux.Promise
-
Callback to invoke when the operation fails.
- fail(Throwable) - Method in class org.cometd.bayeux.Promise.Wrapper
- from(Consumer<T>, Consumer<Throwable>) - Static method in interface org.cometd.bayeux.Promise
G
- getAdvice() - Method in interface org.cometd.bayeux.Message
-
Convenience method to retrieve the
Message.ADVICE_FIELD
- getAdvice(boolean) - Method in interface org.cometd.bayeux.Message.Mutable
-
Convenience method to retrieve the
Message.ADVICE_FIELD
and create it if it does not exist - getAllIds() - Method in class org.cometd.bayeux.ChannelId
- getAllowedTransports() - Method in interface org.cometd.bayeux.Bayeux
- getAttribute(String) - Method in interface org.cometd.bayeux.Channel
-
Retrieves the value of named channel attribute.
- getAttribute(String) - Method in interface org.cometd.bayeux.Session
-
Retrieves the value of named session attribute.
- getAttributeNames() - Method in interface org.cometd.bayeux.Channel
- getAttributeNames() - Method in interface org.cometd.bayeux.Session
- getChannel() - Method in interface org.cometd.bayeux.Message
-
Convenience method to retrieve the
Message.CHANNEL_FIELD
. - getChannelId() - Method in interface org.cometd.bayeux.Channel
- getChannelId() - Method in interface org.cometd.bayeux.Message
-
Convenience method to retrieve the
Message.CHANNEL_FIELD
. - getClientId() - Method in interface org.cometd.bayeux.Message
-
Convenience method to retrieve the
Message.CLIENT_ID_FIELD
- getData() - Method in interface org.cometd.bayeux.Message
-
Convenience method to retrieve the
Message.DATA_FIELD
- getDataAsMap() - Method in interface org.cometd.bayeux.Message
- getDataAsMap(boolean) - Method in interface org.cometd.bayeux.Message.Mutable
-
Convenience method to retrieve the
Message.DATA_FIELD
and create it if it does not exist - getExt() - Method in interface org.cometd.bayeux.Message
-
Convenience method to retrieve the
Message.EXT_FIELD
- getExt(boolean) - Method in interface org.cometd.bayeux.Message.Mutable
-
Convenience method to retrieve the
Message.EXT_FIELD
and create it if it does not exist - getId() - Method in interface org.cometd.bayeux.Channel
- getId() - Method in class org.cometd.bayeux.ChannelId
-
Returns the normalized channel id string.
- getId() - Method in interface org.cometd.bayeux.Message
-
Convenience method to retrieve the
Message.ID_FIELD
- getId() - Method in interface org.cometd.bayeux.Session
-
The clientId of the session.
- getKnownTransportNames() - Method in interface org.cometd.bayeux.Bayeux
- getMetaData() - Method in class org.cometd.bayeux.BinaryData
- getName() - Method in interface org.cometd.bayeux.Transport
- getOption(String) - Method in interface org.cometd.bayeux.Bayeux
- getOption(String) - Method in interface org.cometd.bayeux.Transport
- getOptionNames() - Method in interface org.cometd.bayeux.Bayeux
- getOptionNames() - Method in interface org.cometd.bayeux.Transport
- getOptionPrefix() - Method in interface org.cometd.bayeux.Transport
-
Specifies an option prefix made of string segments separated by the "." character, used to override more generic configuration entries.
- getParameters() - Method in class org.cometd.bayeux.ChannelId
- getParent() - Method in class org.cometd.bayeux.ChannelId
- getReference() - Method in class org.cometd.bayeux.MarkedReference
- getRegularPart() - Method in class org.cometd.bayeux.ChannelId
-
Returns the regular part of this ChannelId: the part of the channel id from the beginning until the first occurrence of a parameter or a wild character.
- getSegment(int) - Method in class org.cometd.bayeux.ChannelId
- getTransport(String) - Method in interface org.cometd.bayeux.Bayeux
- getWildIds() - Method in class org.cometd.bayeux.ChannelId
-
Returns the list of wild channels that match this channel.
- getWilds() - Method in class org.cometd.bayeux.ChannelId
-
Deprecated.
- getWrapped() - Method in class org.cometd.bayeux.Promise.Wrapper
H
- hashCode() - Method in class org.cometd.bayeux.ChannelId
I
- ID_FIELD - Static variable in interface org.cometd.bayeux.Message
- INTERVAL_FIELD - Static variable in interface org.cometd.bayeux.Message
- isAncestorOf(ChannelId) - Method in class org.cometd.bayeux.ChannelId
- isBroadcast() - Method in interface org.cometd.bayeux.Channel
-
A broadcasting channel is a channel that is neither a
meta channel
nor aservice channel
. - isBroadcast() - Method in class org.cometd.bayeux.ChannelId
- isBroadcast(String) - Static method in class org.cometd.bayeux.ChannelId
- isConnected() - Method in interface org.cometd.bayeux.Session
-
A connected session is a session where the link between the client and the server has been established.
- isDeepWild() - Method in interface org.cometd.bayeux.Channel
-
Tells whether a channel contains the deep wild characters '**', for example
/foo/**
- isDeepWild() - Method in class org.cometd.bayeux.ChannelId
- isHandshook() - Method in interface org.cometd.bayeux.Session
-
A handshook session is a session where the handshake has successfully completed
- isLast() - Method in class org.cometd.bayeux.BinaryData
- isMarked() - Method in class org.cometd.bayeux.MarkedReference
- isMeta() - Method in interface org.cometd.bayeux.Channel
-
Tells whether the channel is a meta channel, that is if its
id
starts with"/meta/"
. - isMeta() - Method in class org.cometd.bayeux.ChannelId
-
A
ChannelId
is a metaChannelId
if it starts with"/meta/"
. - isMeta() - Method in interface org.cometd.bayeux.Message
-
A messages that has a meta channel is dubbed a "meta message".
- isMeta(String) - Static method in class org.cometd.bayeux.ChannelId
- isParentOf(ChannelId) - Method in class org.cometd.bayeux.ChannelId
- isPublishReply() - Method in interface org.cometd.bayeux.Message
-
Publish message replies contain the "successful" field
- isService() - Method in interface org.cometd.bayeux.Channel
-
Tells whether the channel is a service channel, that is if its
id
starts with"/service/"
. - isService() - Method in class org.cometd.bayeux.ChannelId
-
A
ChannelId
is a serviceChannelId
if it starts with"/service/"
. - isService(String) - Static method in class org.cometd.bayeux.ChannelId
- isShallowWild() - Method in class org.cometd.bayeux.ChannelId
- isSuccessful() - Method in interface org.cometd.bayeux.Message
-
Convenience method to retrieve the
Message.SUCCESSFUL_FIELD
- isTemplate() - Method in class org.cometd.bayeux.ChannelId
- isValidChannelId(String) - Static method in class org.cometd.bayeux.Bayeux.Validator
- isValidMessageId(String) - Static method in class org.cometd.bayeux.Bayeux.Validator
- isWild() - Method in interface org.cometd.bayeux.Channel
-
Tells whether a channel contains the wild character '*', for example
/foo/*
or if it isChannel.isDeepWild()
. - isWild() - Method in class org.cometd.bayeux.ChannelId
L
- LAST - Static variable in class org.cometd.bayeux.BinaryData
M
- MarkedReference<T> - Class in org.cometd.bayeux
-
Immutable, non-volatile, non-atomic version of
AtomicMarkableReference
. - MarkedReference(T, boolean) - Constructor for class org.cometd.bayeux.MarkedReference
- matches(ChannelId) - Method in class org.cometd.bayeux.ChannelId
-
Tests whether this
ChannelId
matches the givenChannelId
. - MAX_INTERVAL_FIELD - Static variable in interface org.cometd.bayeux.Message
- Message - Interface in org.cometd.bayeux
-
The Bayeux protocol exchange information by means of messages.
- Message.Mutable - Interface in org.cometd.bayeux
-
The mutable version of a
Message
- META - Static variable in class org.cometd.bayeux.BinaryData
- META - Static variable in interface org.cometd.bayeux.Channel
-
Constant representing the meta prefix
- META_CONNECT - Static variable in interface org.cometd.bayeux.Channel
-
Constant representing the connect meta channel
- META_DISCONNECT - Static variable in interface org.cometd.bayeux.Channel
-
Constant representing the disconnect meta channel
- META_HANDSHAKE - Static variable in interface org.cometd.bayeux.Channel
-
Constant representing the handshake meta channel.
- META_SUBSCRIBE - Static variable in interface org.cometd.bayeux.Channel
-
Constant representing the subscribe meta channel
- META_UNSUBSCRIBE - Static variable in interface org.cometd.bayeux.Channel
-
Constant representing the unsubscribe meta channel
- MIN_VERSION_FIELD - Static variable in interface org.cometd.bayeux.Message
N
- noop() - Static method in interface org.cometd.bayeux.Promise
- NOOP - Static variable in interface org.cometd.bayeux.Promise
-
Shared instance whose methods are implemented empty,
O
- org.cometd.api - module org.cometd.api
- org.cometd.bayeux - package org.cometd.bayeux
P
- Promise<C> - Interface in org.cometd.bayeux
-
The future result of an operation, either a value if the operation succeeded, or a failure if the operation failed.
- Promise.Completable<S> - Class in org.cometd.bayeux
-
A CompletableFuture that is also a Promise.
- Promise.Wrapper<W> - Class in org.cometd.bayeux
-
A wrapper for
Promise
instances.
R
- RECONNECT_FIELD - Static variable in interface org.cometd.bayeux.Message
- RECONNECT_HANDSHAKE_VALUE - Static variable in interface org.cometd.bayeux.Message
- RECONNECT_NONE_VALUE - Static variable in interface org.cometd.bayeux.Message
- RECONNECT_RETRY_VALUE - Static variable in interface org.cometd.bayeux.Message
- removeAttribute(String) - Method in interface org.cometd.bayeux.Channel
-
Removes a named channel attribute.
- removeAttribute(String) - Method in interface org.cometd.bayeux.Session
-
Removes a named session attribute.
S
- SERVICE - Static variable in interface org.cometd.bayeux.Channel
-
Constant representing the service prefix
- Session - Interface in org.cometd.bayeux
-
A Bayeux session represents a connection between a bayeux client and a bayeux server.
- setAttribute(String, Object) - Method in interface org.cometd.bayeux.Channel
-
Sets a named channel attribute value.
- setAttribute(String, Object) - Method in interface org.cometd.bayeux.Session
-
Sets a named session attribute value.
- setChannel(String) - Method in interface org.cometd.bayeux.Message.Mutable
- setClientId(String) - Method in interface org.cometd.bayeux.Message.Mutable
- setData(Object) - Method in interface org.cometd.bayeux.Message.Mutable
- setId(String) - Method in interface org.cometd.bayeux.Message.Mutable
- setOption(String, Object) - Method in interface org.cometd.bayeux.Bayeux
- setSuccessful(boolean) - Method in interface org.cometd.bayeux.Message.Mutable
- startBatch() - Method in interface org.cometd.bayeux.Session
-
Starts a batch, to be ended with
endBatch()
. - SUBSCRIPTION_FIELD - Static variable in interface org.cometd.bayeux.Message
- succeed(C) - Method in interface org.cometd.bayeux.Promise
-
Callback to invoke when the operation succeeds.
- succeed(S) - Method in class org.cometd.bayeux.Promise.Completable
- succeed(W) - Method in class org.cometd.bayeux.Promise.Wrapper
- SUCCESSFUL_FIELD - Static variable in interface org.cometd.bayeux.Message
- SUPPORTED_CONNECTION_TYPES_FIELD - Static variable in interface org.cometd.bayeux.Message
T
- TIMEOUT_FIELD - Static variable in interface org.cometd.bayeux.Message
- TIMESTAMP_FIELD - Static variable in interface org.cometd.bayeux.Message
- toString() - Method in class org.cometd.bayeux.ChannelId
- Transport - Interface in org.cometd.bayeux
-
A transport abstract the details of the protocol used to send Bayeux messages over the network, for example using HTTP or using WebSocket.
- TRANSPORT_FIELD - Static variable in interface org.cometd.bayeux.Message
V
- VERSION_FIELD - Static variable in interface org.cometd.bayeux.Message
W
- WILD - Static variable in class org.cometd.bayeux.ChannelId
- Wrapper(Promise<W>) - Constructor for class org.cometd.bayeux.Promise.Wrapper
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
ChannelId.getWildIds()
instead