|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Bayeux
Bayeux Interface. This interface represents the server side API for the Bayeux messaging protocol. Bayeux implementations must be thread safe and multiple threads may simultaneously call Bayeux methods.
Field Summary | |
---|---|
static String |
ADVICE_FIELD
|
static String |
CHANNEL_FIELD
|
static String |
CLIENT_FIELD
|
static String |
DATA_FIELD
|
static String |
DOJOX_COMETD_BAYEUX
ServletContext attribute name used to obtain the Bayeux object |
static String |
ERROR_FIELD
|
static String |
EXT_FIELD
|
static String |
ID_FIELD
|
static String |
META
|
static String |
META_CLIENT
|
static String |
META_CONNECT
|
static String |
META_DISCONNECT
|
static String |
META_HANDSHAKE
|
static String |
META_PING
|
static String |
META_RECONNECT
|
static String |
META_SLASH
|
static String |
META_STATUS
|
static String |
META_SUBSCRIBE
|
static String |
META_UNSUBSCRIBE
|
static String |
SERVICE
|
static String |
SERVICE_SLASH
|
static String |
SUBSCRIPTION_FIELD
|
static String |
SUCCESSFUL_FIELD
|
static String |
TIMESTAMP_FIELD
|
static String |
TRANSPORT_FIELD
|
Method Summary | |
---|---|
void |
addFilter(String channels,
DataFilter filter)
|
void |
deliver(Client fromClient,
Client toClient,
String toChannel,
Message message)
Deliver a message to a client. |
Channel |
getChannel(String channelId,
boolean create)
|
Client |
getClient(String client_id)
|
SecurityPolicy |
getSecurityPolicy()
|
boolean |
hasChannel(String channel)
|
Client |
newClient(String idprefix,
Listener listener)
|
Message |
newMessage()
|
void |
publish(Client fromClient,
String toChannel,
Object data,
String msgId)
Deliver data to a channel. |
void |
removeFilter(String channels,
DataFilter filter)
|
void |
setSecurityPolicy(SecurityPolicy securityPolicy)
|
void |
subscribe(String toChannel,
Client subscriber)
Subscribe to a channel. |
void |
unsubscribe(String toChannel,
Client subscriber)
Unsubscribe to a channel |
Field Detail |
---|
static final String META
static final String META_SLASH
static final String META_CONNECT
static final String META_CLIENT
static final String META_DISCONNECT
static final String META_HANDSHAKE
static final String META_PING
static final String META_RECONNECT
static final String META_STATUS
static final String META_SUBSCRIBE
static final String META_UNSUBSCRIBE
static final String CLIENT_FIELD
static final String DATA_FIELD
static final String CHANNEL_FIELD
static final String ID_FIELD
static final String ERROR_FIELD
static final String TIMESTAMP_FIELD
static final String TRANSPORT_FIELD
static final String ADVICE_FIELD
static final String SUCCESSFUL_FIELD
static final String SUBSCRIPTION_FIELD
static final String EXT_FIELD
static final String SERVICE
static final String SERVICE_SLASH
static final String DOJOX_COMETD_BAYEUX
Method Detail |
---|
Client newClient(String idprefix, Listener listener)
idprefix
- listener
-
Client getClient(String client_id)
client_id
-
Channel getChannel(String channelId, boolean create)
void publish(Client fromClient, String toChannel, Object data, String msgId)
fromClient
- The client sending the datadata
- The data itself which must be an Object that can be encoded with JSON
.toChannel
- The Channel ID to which the data is targettedmsgId
- optional message ID or null for automatic generation of a message ID.void deliver(Client fromClient, Client toClient, String toChannel, Message message)
void subscribe(String toChannel, Client subscriber)
toChannel
- subscriber
- createChannel.
- Create the channel if it does not existvoid unsubscribe(String toChannel, Client subscriber)
toChannel
- subscriber
- boolean hasChannel(String channel)
void addFilter(String channels, DataFilter filter)
void removeFilter(String channels, DataFilter filter)
SecurityPolicy getSecurityPolicy()
void setSecurityPolicy(SecurityPolicy securityPolicy)
Message newMessage()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |