Package | Description |
---|---|
com.pushtechnology.diffusion.client |
Client API.
|
com.pushtechnology.diffusion.client.features |
Client API : Standard Features.
|
com.pushtechnology.diffusion.client.features.control.clients |
Client API : Client Control Features.
|
com.pushtechnology.diffusion.client.features.control.topics |
Client API : Topic Control Features.
|
com.pushtechnology.diffusion.client.session |
Client API : Sessions.
|
Modifier and Type | Method and Description |
---|---|
static SessionId |
Diffusion.sessionIdFromString(String sessionIdAsString)
Parse a
SessionId from a string. |
SessionId |
Diffusion.Implementation.sessionIdFromString(String sessionIdAsString)
Parses a session id from a string.
|
Modifier and Type | Method and Description |
---|---|
SessionId |
Messaging.RequestHandler.RequestContext.getSessionId()
SessionId of the session that sent the request.
|
Modifier and Type | Method and Description |
---|---|
void |
Messaging.FilteredRequestCallback.onResponse(SessionId sessionId,
R response)
Called when a response has been received.
|
void |
Messaging.FilteredRequestCallback.Default.onResponse(SessionId sessionId,
R response) |
void |
Messaging.FilteredRequestCallback.onResponseError(SessionId sessionId,
Throwable throwable)
Called when a response from a session results in an error.
|
void |
Messaging.FilteredRequestCallback.Default.onResponseError(SessionId sessionId,
Throwable throwable) |
<T,R> CompletableFuture<R> |
Messaging.sendRequest(SessionId sessionId,
String path,
T request,
Class<T> requestType,
Class<R> responseType)
Send a request to a session.
|
Modifier and Type | Method and Description |
---|---|
SessionId |
ClientControl.SessionEventStream.Event.sessionId()
Provides the session identifier of the client session that the
event relates to.
|
SessionId |
ClientControl.sessionIdFromString(String sessionIdAsString)
Deprecated.
since 6.7
Use |
Modifier and Type | Method and Description |
---|---|
CompletableFuture<?> |
ClientControl.changeRoles(SessionId sessionId,
Set<String> rolesToRemove,
Set<String> rolesToAdd)
Changes the assigned roles of another session.
|
CompletableFuture<?> |
ClientControl.close(SessionId sessionId)
Close a client session.
|
<C> void |
ClientControl.close(SessionId sessionId,
C context,
ClientControl.ClientContextCallback<C> callback)
Deprecated.
since 6.7
Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead. |
void |
ClientControl.close(SessionId sessionId,
ClientControl.ClientCallback callback)
Deprecated.
since 6.7
Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead. |
CompletableFuture<Map<String,String>> |
ClientControl.getSessionProperties(SessionId sessionId,
Collection<String> requiredProperties)
Query the server for property values of a specified client session.
|
<C> void |
ClientControl.getSessionProperties(SessionId sessionId,
Collection<String> requiredProperties,
C context,
ClientControl.SessionPropertiesContextCallback<C> callback)
Deprecated.
since 6.7
Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead. |
void |
ClientControl.getSessionProperties(SessionId sessionId,
Collection<String> requiredProperties,
ClientControl.SessionPropertiesCallback callback)
Deprecated.
since 6.7
Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead. |
void |
ClientControl.QueueEventStream.onLowerThresholdCrossed(SessionId sessionId,
MessageQueuePolicy policy)
The configured lower threshold for a client's queue has been reached.
|
void |
ClientControl.QueueEventStream.Default.onLowerThresholdCrossed(SessionId sessionId,
MessageQueuePolicy policy) |
void |
ClientControl.QueueEventHandler.onLowerThresholdCrossed(SessionId sessionId,
MessageQueuePolicy policy)
Deprecated.
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)
Deprecated.
Called to return requested session properties.
|
void |
ClientControl.SessionPropertiesCallback.onReply(SessionId sessionId,
Map<String,String> properties)
Deprecated.
Called to return requested session properties.
|
void |
ClientControl.SessionPropertiesStream.onSessionClose(SessionId sessionId,
Map<String,String> properties,
ClientControl.CloseReason closeReason)
Deprecated.
Notification that a client session has closed.
|
void |
ClientControl.SessionPropertiesStream.Default.onSessionClose(SessionId sessionId,
Map<String,String> properties,
ClientControl.CloseReason closeReason) |
void |
ClientControl.SessionPropertiesStream.onSessionEvent(SessionId sessionId,
ClientControl.SessionPropertiesStream.EventType eventType,
Map<String,String> properties,
Map<String,String> previousValues)
Deprecated.
Notification of a session event that can result in a change of
properties.
|
void |
ClientControl.SessionPropertiesStream.Default.onSessionEvent(SessionId sessionId,
ClientControl.SessionPropertiesStream.EventType eventType,
Map<String,String> properties,
Map<String,String> previousValues) |
void |
ClientControl.SessionPropertiesStream.onSessionOpen(SessionId sessionId,
Map<String,String> properties)
Deprecated.
Notification that a new client session has been opened.
|
void |
ClientControl.SessionPropertiesStream.Default.onSessionOpen(SessionId sessionId,
Map<String,String> properties) |
void |
ClientControl.SessionPropertiesContextCallback.onUnknownSession(C context,
SessionId sessionId)
Deprecated.
Called to indicate that the session indicated in a request is not
known by the server.
|
void |
ClientControl.SessionPropertiesCallback.onUnknownSession(SessionId sessionId)
Deprecated.
Called to indicate that the session indicated in a request is not
known by the server.
|
void |
ClientControl.QueueEventStream.onUpperThresholdCrossed(SessionId sessionId,
MessageQueuePolicy policy)
The configured upper threshold for a client's queue has been reached.
|
void |
ClientControl.QueueEventStream.Default.onUpperThresholdCrossed(SessionId sessionId,
MessageQueuePolicy policy) |
void |
ClientControl.QueueEventHandler.onUpperThresholdCrossed(SessionId sessionId,
MessageQueuePolicy policy)
Deprecated.
The configured upper threshold for a client's queue has been reached.
|
void |
ClientControl.QueueEventHandler.Default.onUpperThresholdCrossed(SessionId sessionId,
MessageQueuePolicy policy) |
CompletableFuture<?> |
ClientControl.setConflated(SessionId sessionId,
boolean conflate)
Control client queue conflation.
|
<C> void |
ClientControl.setConflated(SessionId sessionId,
boolean conflate,
C context,
ClientControl.ClientContextCallback<C> callback)
Deprecated.
since 6.7
Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead. |
void |
ClientControl.setConflated(SessionId sessionId,
boolean conflate,
ClientControl.ClientCallback callback)
Deprecated.
since 6.7
Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead. |
CompletableFuture<Map<String,String>> |
ClientControl.setSessionProperties(SessionId sessionId,
Map<String,String> properties)
Send a request to the server to change the user-defined session
properties for a session.
|
Modifier and Type | Method and Description |
---|---|
default SessionId |
TopicControl.MissingTopicNotification.getSessionId()
Returns the identity of the session that made the request.
|
Modifier and Type | Method and Description |
---|---|
CompletableFuture<?> |
SubscriptionControl.subscribe(SessionId sessionId,
String topics)
Subscribe another session to topics.
|
<C> void |
SubscriptionControl.subscribe(SessionId sessionId,
String topics,
C context,
SubscriptionControl.SubscriptionContextCallback<C> callback)
Deprecated.
since 6.7
Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead. |
void |
SubscriptionControl.subscribe(SessionId sessionId,
String topics,
SubscriptionControl.SubscriptionCallback callback)
Deprecated.
since 6.7
Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead. |
CompletableFuture<?> |
SubscriptionControl.subscribe(SessionId sessionId,
TopicSelector topics)
Subscribe another session to topics.
|
<C> void |
SubscriptionControl.subscribe(SessionId sessionId,
TopicSelector topics,
C context,
SubscriptionControl.SubscriptionContextCallback<C> callback)
Deprecated.
since 6.7
Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead. |
void |
SubscriptionControl.subscribe(SessionId sessionId,
TopicSelector topics,
SubscriptionControl.SubscriptionCallback callback)
Deprecated.
since 6.7
Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead. |
CompletableFuture<?> |
SubscriptionControl.unsubscribe(SessionId sessionId,
String topics)
Unsubscribe another session from topics.
|
<C> void |
SubscriptionControl.unsubscribe(SessionId sessionId,
String topics,
C context,
SubscriptionControl.SubscriptionContextCallback<C> callback)
Deprecated.
since 6.7
Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead. |
void |
SubscriptionControl.unsubscribe(SessionId sessionId,
String topics,
SubscriptionControl.SubscriptionCallback callback)
Deprecated.
since 6.7
Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead. |
CompletableFuture<?> |
SubscriptionControl.unsubscribe(SessionId sessionId,
TopicSelector topics)
Unsubscribe another session from topics.
|
<C> void |
SubscriptionControl.unsubscribe(SessionId sessionId,
TopicSelector topics,
C context,
SubscriptionControl.SubscriptionContextCallback<C> callback)
Deprecated.
since 6.7
Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead. |
void |
SubscriptionControl.unsubscribe(SessionId sessionId,
TopicSelector topics,
SubscriptionControl.SubscriptionCallback callback)
Deprecated.
since 6.7
Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead. |
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 © 2024 DiffusionData Ltd. All Rights Reserved.