|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Client
A Bayeux Client.
A client may subscribe to channels and publish messages to channels.
Client instances should not be directly created by uses, but should
be obtained via the Bayeux.getClient(String)
or Bayeux#newClient(String, Receiver)
methods.
Three types of client may be represented by this interface:
Method Summary | |
---|---|
void |
addListener(EventListener listener)
|
void |
deliver(Client from,
Message message)
Deprecated. use deliver(Client, String, Object, String) |
void |
deliver(Client from,
String toChannel,
Object data,
String id)
|
void |
endBatch()
End a batch of messages. |
String |
getId()
|
Listener |
getListener()
Deprecated. Returns only the first listener added |
boolean |
hasMessages()
|
boolean |
isLocal()
|
void |
publish(String toChannel,
Object data,
String msgId)
Deprecated. use Channel.publish(Client, Object, String) |
void |
removeListener(EventListener listener)
|
void |
setListener(Listener listener)
Deprecated. use addListener(EventListener) |
void |
startBatch()
Start a batch of messages. |
void |
subscribe(String toChannel)
Deprecated. use Channel.subscribe(Client) |
List<Message> |
takeMessages()
Take any messages queued for a client. |
void |
unsubscribe(String toChannel)
Deprecated. use Channel.unsubscribe(Client) |
Method Detail |
---|
String getId()
void publish(String toChannel, Object data, String msgId)
Channel.publish(Client, Object, String)
Bayeux.publish(Client, String, Object, String)
with this client passed
as the fromClient.
data
- 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 subscribe(String toChannel)
Channel.subscribe(Client)
Bayeux.subscribe(String, Client)
with this client passed.
Equivalent to getChannel(toChannel).subscribe(subscriber).
toChannel
- void unsubscribe(String toChannel)
Channel.unsubscribe(Client)
Bayeux.unsubscribe(String, Client)
with this client passed.
toChannel
- boolean hasMessages()
List<Message> takeMessages()
void deliver(Client from, Message message)
deliver(Client, String, Object, String)
from
- The Client that published the message, or null if not known/availablemessage
- void deliver(Client from, String toChannel, Object data, String id)
void setListener(Listener listener)
addListener(EventListener)
Listener getListener()
void addListener(EventListener listener)
void removeListener(EventListener listener)
boolean isLocal()
void startBatch()
void endBatch()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |