|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Channel represents a pub/sub channel. A channel can have sub channels beneath it like a hierarchical structure.
Inner Class Summary | |
static class |
Channel.ChannelPattern
This enum provides constants of the three channel patterns that are described in section 2.2.1 Channel Globbing of Bayeux Protocol -- Bayeux 1.0draft1 . |
Method Summary | |
void |
addSubChannel(Channel child)
Add one immediate child channel to this channel |
void |
destroy(Client client)
Destroy this channel and all subchannels beneath it |
java.util.List |
getClients(Channel.ChannelPattern pattern)
Return back list of clients who may interested in this channel or its children, depending on pattern parameter passed in. |
java.lang.String |
getName()
Return the fully qualified name of this Channel. |
Channel |
getParentChannel()
Return current channel's parent or null if current channel is root. |
long |
getPublishedMessageCount()
Get count of messages published to the channel |
java.util.List |
getSubChannels()
Return the list of immediate child channels for the current channel |
boolean |
isMetaChannel()
Judge whether the channel is a meta channel. |
boolean |
isPersistentChannel()
Judge whether the channel is a persistent channel or not. |
void |
publish(BayeuxMessage message,
Channel.ChannelPattern pattern)
Publish to this channel or its child channels with specified pattern. |
void |
registerListener(ChannelMessageListener listener)
Register ChannelMessageListener object to this Channel. |
void |
removeSubChannel(Channel child)
Remove sub channel from this channel. |
void |
subscribe(Client client)
Subscribe to this channel. |
void |
subscribe(Client client,
Channel.ChannelPattern pattern)
Subscribe to this channel or its child channels with specified pattern. |
void |
unregisterListener(ChannelMessageListener listener)
Unregister ChannnelMessageListener object from this channel |
void |
unsubscribe(Client client)
Unsubscribe from all of this channel. |
void |
unsubscribe(Client client,
Channel.ChannelPattern pattern)
Unsubscribe from this channel. |
Method Detail |
public java.lang.String getName()
public Channel getParentChannel()
public java.util.List getSubChannels()
public void addSubChannel(Channel child)
child
- child channel.public void removeSubChannel(Channel child)
child
- child channel.public void destroy(Client client)
client
- Client object.public java.util.List getClients(Channel.ChannelPattern pattern)
pattern
- subscribe pattern, valid values are ITSELF,
IMMEDIATE_SUBCHANNELS, ALL_SUBCHANNELSpublic void subscribe(Client client) throws PubSubSecurityException
This method is equivalent to: subscribe(client, ChannelPattern.ITSELF);
client
- Client object.public void subscribe(Client client, Channel.ChannelPattern pattern) throws PubSubSecurityException
client
- client to subscribe this channelpattern
- pattern deciding which channels beneath the current channel
should be subscribed.public void unsubscribe(Client client)
This method is equivalent to: unsubscribe(client, ChannelPattern.ITSELF); unsubscribe(client, ChannelPattern.IMMEDIATE_SUBCHANNELS); unsubscribe(client, ChannelPattern.ALL_SUBCHANNELS);
client
- client object.public void unsubscribe(Client client, Channel.ChannelPattern pattern)
client
- client to unsubscribe this channelpattern
- pattern deciding which channels beneath the current channel
should be unsubscribed.public void publish(BayeuxMessage message, Channel.ChannelPattern pattern) throws PubSubSecurityException
message
- BayeuxMessage to publish.pattern
- channel pattern to decide where to publishpublic long getPublishedMessageCount()
public boolean isMetaChannel()
public boolean isPersistentChannel()
public void registerListener(ChannelMessageListener listener)
listener
- ChannelMessageListener object.public void unregisterListener(ChannelMessageListener listener)
listener
- ChannelMessageListener object.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |