| Connecting |
| Connect to the Diffusion server |
 |
|
|
|
|
|
| Cascade
connection through multiple transports |
|
 |
|
|
|
|
| Connect
asynchronously |
|
|
|
|
|
|
| Connect
synchronously |
|
|
|
|
|
|
| Connect using a URL-style
string as a parameter |
|
|
|
|
|
|
| Connect using individual
parameters |
|
|
|
|
|
|
| Connect
securely |
|
|
|
|
|
|
| Configure SSL context
or behavior |
|
|
|
|
|
|
| Connect through an HTTP proxy |
|
|
|
|
|
|
| Connect through a load
balancer |
|
|
|
|
|
|
| Pass a request path to a load
balancer |
|
|
|
|
|
|
| Reconnecting |
| Reconnect to the Diffusion server |
|
|
|
|
|
|
| Configure a reconnection
timeout |
|
|
|
|
|
|
| Define a custom reconnection
strategy |
|
|
|
|
|
|
| Resynchronize
message streams on reconnect |
|
|
|
|
|
|
| Abort reconnect if
resynchronization fails |
|
|
|
|
|
|
| Maintain a recovery
buffer of messages on the client to resend to the Diffusion server on reconnect |
|
|
|
|
|
|
| Configure the
client-side recovery buffer |
|
|
|
|
|
|
| Detect
disconnections by monitoring activity |
|
|
|
|
|
|
| Detect disconnections by
using TCP state |
|
|
|
|
|
|
| Ping the Diffusion server |
|
|
|
|
|
|
| Change the principal used by the
connected client session |
|
|
|
|
|
|
| Receiving data from topics |
| Subscribe to a topic or set
of topics |
|
|
|
|
|
|
| Receive data as a value
stream |
|
|
|
|
|
|
| Receive data as
content |
|
|
|
|
|
|
| Fetch the state of a
topic |
|
|
|
|
|
|
| Managing topics |
| Create a topic |
|
|
|
|
|
|
| Create a slave topic |
|
|
|
|
|
|
| Create/update/query time series topics |
|
|
|
|
|
|
| Create a topic from an initial
value |
|
|
|
|
|
|
| Create a topic from a topic
specification |
|
|
|
|
|
|
| Create a topic from topic
details |
|
|
|
|
|
|
| Create a topic with
metadata |
|
|
|
|
|
|
| Listen for topic events
(including topic has subscribers and topic has zero subscribers) |
|
|
|
|
|
|
| Receive topic notifications |
|
|
|
|
|
|
| Delete a
topic |
|
|
|
|
|
|
| Delete a branch of the
topic tree |
|
|
|
|
|
|
| Set an automatic topic removal policy |
|
|
|
|
|
|
| Mark a branch of the topic tree for
deletion when this client session is closed |
|
|
|
|
|
|
| Updating topics |
| Update a topic |
|
|
|
|
|
|
| Perform exclusive
updates |
|
|
|
|
|
|
| Perform non-exclusive
updates |
|
|
|
|
|
|
| Managing subscriptions |
| Subscribe or unsubscribe another
client to a topic |
|
|
|
|
|
|
| Subscribe or unsubscribe another
client to a topic based on session properties |
|
|
|
|
|
|
| Handling subscriptions to
routing topics |
|
|
|
|
|
|
| Handling subscriptions to missing
topics |
|
|
|
|
|
|
| Request-response messaging |
| Send a request to a
path |
|
|
|
|
|
|
| Send a request to a client
session |
|
|
|
|
|
|
| Send a request to a set of client
sessions based on session properties |
|
|
|
|
|
|
| Respond to requests sent to a
session |
|
|
|
|
|
|
| Respond to requests sent to a
path |
|
|
|
|
|
|
| One-way messaging |
| Send a one-way message to a
path |
|
|
|
|
|
|
| Send a one-way message to a
client session |
|
|
|
|
|
|
| Send a one-way message to a set
of client sessions based on session properties |
|
|
|
|
|
|
| Receive one-way
messages |
|
|
|
|
|
|
| Handle one-way messages sent to a
path |
|
|
|
|
|
|
| Managing security |
| Authenticate client sessions and
assign roles to client sessions |
|
|
|
|
|
|
| Configure how the Diffusion server authenticates client sessions and assign roles to
client sessions |
|
|
|
|
|
|
| Configure the roles assigned to
anonymous sessions and named sessions |
|
|
|
|
|
|
| Configure the permissions associated
with roles assigned to client sessions |
|
|
|
|
|
|
| Grant permissions to a principal using topic ownership |
|
|
|
|
|
|
| Managing other clients |
| Receive
notifications about client session events including session
properties |
|
|
|
|
|
|
| Get the properties of a
specific client session |
|
|
|
|
|
|
| Update user-defined session properties of a
client session or set of sessions |
|
|
|
|
|
|
| Receive
notifications about client queue events |
|
|
|
|
|
|
| Conflate and
throttle clients |
|
|
|
|
|
|
| Close a client
session |
|
|
|
|
|
|
| Push
notifications (The Push Notification Bridge must be enabled) |
| Receive push notifications |
|
|
|
|
|
|
| Request that push notifications be sent from a topic to a client |
|
|
|
|
|
|
| Publish an update to a topic that sends push notifications |
|
|
|
|
|
|
| Other capabilities |
| Flow control |
|
|
|
|
|
|