Package | Description |
---|---|
com.pushtechnology.diffusion.client.features.control.clients |
Unified API - Client Control Features.
|
com.pushtechnology.diffusion.client.features.control.topics |
Unified API - Topic Control Features.
|
com.pushtechnology.diffusion.client.session |
Unified API - Sessions.
|
Modifier and Type | Method and Description |
---|---|
SessionId |
ClientControl.sessionIdFromString(String sessionIdAsString)
Restore a
SessionId from a string. |
Modifier and Type | Method and Description |
---|---|
<C> void |
ClientControl.close(SessionId sessionId,
C context,
ClientControl.ClientContextCallback<C> callback)
Close a client session with a contextual callback.
|
void |
ClientControl.close(SessionId sessionId,
ClientControl.ClientCallback callback)
Close a client session.
|
<C> void |
ClientControl.close(SessionId sessionId,
String reason,
C context,
ClientControl.ClientContextCallback<C> callback)
Deprecated.
since 5.5. The reason parameter is not passed to the client
session being closed. Prefer
ClientControl.close(SessionId sessionId, ClientCallback callback)
instead.
If you want to notify the client being closed of the reason
for its closure, use the MessagingControl feature to send a
message to the client. To ensure that this message is
received before closing the client session, wait for the
callback to return before calling
ClientControl.close(SessionId sessionId, ClientCallback callback) |
void |
ClientControl.close(SessionId sessionId,
String reason,
ClientControl.ClientCallback callback)
Deprecated.
since 5.5. The reason parameter is not passed to the client
session being closed. Prefer
ClientControl.close(SessionId sessionId, ClientCallback callback)
instead.
If you want to notify the client being closed of the reason
for its closure, use the MessagingControl feature to send a
message to the client. To ensure that this message is
received before closing the client session, wait for the
callback to return before calling
ClientControl.close(SessionId sessionId, ClientCallback callback) |
<C> void |
ClientControl.getSessionDetails(SessionId sessionId,
Set<SessionDetails.DetailType> types,
C context,
ClientControl.SessionDetailsContextCallback<C> callback)
Deprecated.
since 5.6 the use of
ClientControl.getSessionProperties(SessionId, Collection, Object, SessionPropertiesContextCallback)
is preferred and this method will be removed at a future
release |
void |
ClientControl.getSessionDetails(SessionId sessionId,
Set<SessionDetails.DetailType> types,
ClientControl.SessionDetailsCallback callback)
Deprecated.
since 5.6 the use of
ClientControl.getSessionProperties(SessionId, Collection, SessionPropertiesCallback)
is preferred and this method will be removed at a future
release |
<C> void |
ClientControl.getSessionProperties(SessionId sessionId,
Collection<String> requiredProperties,
C context,
ClientControl.SessionPropertiesContextCallback<C> callback)
Query the server for property values of a specified client session.
|
void |
ClientControl.getSessionProperties(SessionId sessionId,
Collection<String> requiredProperties,
ClientControl.SessionPropertiesCallback callback)
Query the server for property values of a specified client session.
|
void |
ClientControl.QueueEventHandler.onLowerThresholdCrossed(SessionId sessionId,
MessageQueuePolicy policy)
The configured lower threshold for a client's queue has been reached.
|
void |
ClientControl.QueueEventHandler.Default.onLowerThresholdCrossed(SessionId sessionId,
MessageQueuePolicy policy) |
void |
ClientControl.SessionPropertiesContextCallback.onReply(C context,
SessionId sessionId,
Map<String,String> properties)
Called to return requested session properties.
|
void |
ClientControl.SessionDetailsContextCallback.onReply(C context,
SessionId sessionId,
SessionDetails sessionDetails)
Called to return requested session details.
|
void |
ClientControl.SessionDetailsContextCallback.Default.onReply(C context,
SessionId sessionId,
SessionDetails sessionDetails) |
void |
ClientControl.SessionPropertiesCallback.onReply(SessionId sessionId,
Map<String,String> properties)
Called to return requested session properties.
|
void |
ClientControl.SessionDetailsCallback.onReply(SessionId sessionId,
SessionDetails sessionDetails)
Called to return requested session details.
|
void |
ClientControl.SessionDetailsCallback.Default.onReply(SessionId sessionId,
SessionDetails sessionDetails) |
void |
ClientControl.SessionPropertiesListener.onSessionClose(SessionId sessionId,
Map<String,String> properties,
ClientControl.CloseReason closeReason)
Notification that a client session has closed.
|
void |
ClientControl.SessionPropertiesListener.Default.onSessionClose(SessionId sessionId,
Map<String,String> properties,
ClientControl.CloseReason closeReason) |
void |
ClientControl.SessionDetailsListener.onSessionClose(SessionId sessionId,
SessionDetails sessionDetails,
ClientControl.CloseReason closeReason)
Notification that a client session has closed.
|
void |
ClientControl.SessionDetailsListener.Default.onSessionClose(SessionId sessionId,
SessionDetails sessionDetails,
ClientControl.CloseReason finalState) |
void |
ClientControl.SessionPropertiesListener.onSessionEvent(SessionId sessionId,
ClientControl.SessionPropertiesListener.EventType eventType,
Map<String,String> properties,
Map<String,String> previousValues)
Notification of a session event that can result in a change of
properties.
|
void |
ClientControl.SessionPropertiesListener.Default.onSessionEvent(SessionId sessionId,
ClientControl.SessionPropertiesListener.EventType eventType,
Map<String,String> properties,
Map<String,String> previousValues) |
void |
ClientControl.SessionPropertiesListener.onSessionOpen(SessionId sessionId,
Map<String,String> properties)
Notification that a new client session has been opened.
|
void |
ClientControl.SessionPropertiesListener.Default.onSessionOpen(SessionId sessionId,
Map<String,String> properties) |
void |
ClientControl.SessionDetailsListener.onSessionOpen(SessionId sessionId,
SessionDetails sessionDetails)
Notification that a new client session has been opened.
|
void |
ClientControl.SessionDetailsListener.Default.onSessionOpen(SessionId sessionId,
SessionDetails sessionDetails) |
void |
ClientControl.SessionDetailsListener.onSessionUpdate(SessionId sessionId,
SessionDetails sessionDetails)
Notification of a change to a client session.
|
void |
ClientControl.SessionDetailsListener.Default.onSessionUpdate(SessionId sessionId,
SessionDetails sessionDetails) |
void |
ClientControl.SessionPropertiesContextCallback.onUnknownSession(C context,
SessionId sessionId)
Called to indicate that the session indicated in a request is not
known by the server.
|
void |
ClientControl.SessionDetailsContextCallback.onUnknownSession(C context,
SessionId sessionId)
Called to indicate that the session indicated in a request is not
known by the server.
|
void |
ClientControl.SessionDetailsContextCallback.Default.onUnknownSession(C context,
SessionId sessionId) |
void |
ClientControl.SessionPropertiesCallback.onUnknownSession(SessionId sessionId)
Called to indicate that the session indicated in a request is not
known by the server.
|
void |
ClientControl.SessionDetailsCallback.onUnknownSession(SessionId sessionId)
Called to indicate that the session indicated in a request is not
known by the server.
|
void |
ClientControl.SessionDetailsCallback.Default.onUnknownSession(SessionId sessionId) |
void |
ClientControl.QueueEventHandler.onUpperThresholdCrossed(SessionId sessionId,
MessageQueuePolicy policy)
The configured upper threshold for a client's queue has been reached.
|
void |
ClientControl.QueueEventHandler.Default.onUpperThresholdCrossed(SessionId sessionId,
MessageQueuePolicy policy) |
<C> void |
ClientControl.setConflated(SessionId sessionId,
boolean conflate,
C context,
ClientControl.ClientContextCallback<C> callback)
Control client queue conflation with a contextual callback.
|
void |
ClientControl.setConflated(SessionId sessionId,
boolean conflate,
ClientControl.ClientCallback callback)
Control client queue conflation.
|
<C> void |
ClientControl.setThrottled(SessionId sessionId,
MessageQueuePolicy.ThrottlerType throttlerType,
int throttlingLimit,
C context,
ClientControl.ClientContextCallback<C> callback)
Instruct a client session to conflate its message queue, and to throttle
the queue according to the provided parameters.
|
void |
ClientControl.setThrottled(SessionId sessionId,
MessageQueuePolicy.ThrottlerType throttlerType,
int throttlingLimit,
ClientControl.ClientCallback callback)
Instruct a client session to conflate its message queue, and to throttle
the queue according to the provided parameters.
|
Modifier and Type | Method and Description |
---|---|
SessionId |
TopicControl.MissingTopicNotification.getSessionId()
Returns the identity of the client session that made the request.
|
SessionId |
SubscriptionControl.RoutingSubscriptionRequest.getSessionId()
Identifies the client session making the subscription request.
|
Modifier and Type | Method and Description |
---|---|
void |
MessagingControl.MessageHandler.onMessage(SessionId sessionId,
String topicPath,
Content content,
ReceiveContext context)
Receives messages sent from client sessions via a topic.
|
<C> void |
MessagingControl.send(SessionId sessionId,
String topicPath,
Bytes message,
C context,
MessagingControl.SendContextCallback<C> callback)
Send a message to a session via a specific topic.
|
void |
MessagingControl.send(SessionId sessionId,
String topicPath,
Bytes message,
MessagingControl.SendCallback callback)
Send a message to a session via a specific topic.
|
<C> void |
MessagingControl.send(SessionId sessionId,
String topicPath,
Bytes message,
SendOptions options,
C context,
MessagingControl.SendContextCallback<C> callback)
Send message to a session via a specific topic.
|
void |
MessagingControl.send(SessionId sessionId,
String topicPath,
Bytes message,
SendOptions options,
MessagingControl.SendCallback callback)
Send a message to a session via a specific topic.
|
<C> void |
MessagingControl.send(SessionId sessionId,
String topicPath,
CharSequence message,
C context,
MessagingControl.SendContextCallback<C> callback)
Send message to a session via a specific topic.
|
void |
MessagingControl.send(SessionId sessionId,
String topicPath,
CharSequence message,
MessagingControl.SendCallback callback)
Send a message to a session via a specific topic.
|
<C> void |
SubscriptionControl.subscribe(SessionId sessionId,
String topics,
C context,
SubscriptionControl.SubscriptionContextCallback<C> callback)
Subscribe a client session to topics.
|
void |
SubscriptionControl.subscribe(SessionId sessionId,
String topics,
SubscriptionControl.SubscriptionCallback callback)
Subscribe a client session to topics.
|
<C> void |
SubscriptionControl.subscribe(SessionId sessionId,
TopicSelector topics,
C context,
SubscriptionControl.SubscriptionContextCallback<C> callback)
Subscribe a client session to topics.
|
void |
SubscriptionControl.subscribe(SessionId sessionId,
TopicSelector topics,
SubscriptionControl.SubscriptionCallback callback)
Subscribe a client session to topics.
|
<C> void |
SubscriptionControl.unsubscribe(SessionId sessionId,
String topics,
C context,
SubscriptionControl.SubscriptionContextCallback<C> callback)
Unsubscribe a client session from topics.
|
void |
SubscriptionControl.unsubscribe(SessionId sessionId,
String topics,
SubscriptionControl.SubscriptionCallback callback)
Unsubscribe a client session from topics.
|
<C> void |
SubscriptionControl.unsubscribe(SessionId sessionId,
TopicSelector topics,
C context,
SubscriptionControl.SubscriptionContextCallback<C> callback)
Unsubscribe a client session from topics.
|
void |
SubscriptionControl.unsubscribe(SessionId sessionId,
TopicSelector topics,
SubscriptionControl.SubscriptionCallback callback)
Unsubscribe a client session from topics.
|
Modifier and Type | Method and Description |
---|---|
SessionId |
Session.getSessionId()
Returns the unique identifier for the session as assigned by the (first)
server it connects to.
|
Copyright © 2016 Push Technology Ltd. All Rights Reserved.