Classes
- AuthenticationHandler
- Callback
- ClientLocation
- ClientSummary
- Binary
- BinaryDataType
- BinaryDelta
- Bytes
- DataType
- DeltaType
- DoubleDataType
- Int64
- Int64DataType
- JSON
- JSONDataType
- JSONDelta
- ChangeMap
- RecordV2
- RecordV2DataType
- RecordV2Delta
- MutableRecordModel
- RecordModel
- RecordV2Builder
- Schema
- SchemaBuilder
- StringDataType
- FetchRequest
- FetchResult
- TopicResult
- TopicSpecification
- PartialJSON
- UpdateConstraint
- UpdateConstraintFactory
- UpdateStream
- ErrorReport
- Event
- EventMetadata
- FetchStream
- MissingTopicHandler
- MissingTopicNotification
- QueryResult
- RangeQuery
- Result
- SecurityScriptBuilder
- Session
- SessionPropertiesListener
- FilteredResponseHandler
- MessageHandler
- MessageStream
- Registration
- RequestHandler
- RequestStream
- Responder
- SessionDetails
- SessionLock
- Stream
- SystemAuthenticationScriptBuilder
- TopicNotificationListener
- TopicNotificationRegistration
- TopicSelector
- TopicUpdateHandler
- Updater
- ValueStream
Namespaces
- diffusion
- clients
- datatypes
- locks
- selectors
- topics
- topicUpdate
- clients
- messages
- notifications
- security
- timeseries
- topics
- topicUpdate
Events
-
close
-
Emitted when the Stream has been closed through completion or the underlying session has been closed. No further events will be emitted after this.
- Inherited From:
-
error
-
Emitted when an error occurs in the Stream or in any of its listeners. No further events will be emitted after this.
- Inherited From:
Properties:
Name Type Description error
Error the error that occurred
-
open
-
Emitted when the fetch stream is initially opened. This will only be fired once.
-
value
-
Emitted when a topic that is selected by the fetch request's topic selector has returned its value. By default, values are provided as
Buffer
instances. The topic path specifies which topic this value is for.Properties:
Name Type Description value
Buffer the new value of the topic
topicPath
String the path to the topic to which the value update applies
-
close
-
Emitted when the Stream has been closed through completion or the underlying session has been closed. No further events will be emitted after this.
- Inherited From:
-
error
-
Emitted when an error occurs in the Stream or in any of its listeners. No further events will be emitted after this.
- Inherited From:
Properties:
Name Type Description error
Error the error that occurred
-
message
-
Emitted when a new message is received.
Properties:
Name Type Description message
Session.messages.Message the message that has been delivered.
-
close
-
Emitted when a session is closed. This can occur because it was closed by the user, closed by the server, failed to connect, or the session encountered an error. The provided close reason will contain the specific cause of the session close.
Properties:
Name Type Description reason
diffusion.clients.CloseReason the cause of the session close.
-
disconnect
-
Emitted when a connected session has lost connection to the server, and Session.Options
reconnect
is enabled. The provided reason will contain the specific cause of the session disconnect.Properties:
Name Type Description reason
diffusion.clients.CloseReason the cause of the session disconnect.
-
error
-
Emitted when a session error has occurred. A session error occurs when the client cannot parse communication from the server. This occurs if a component between the two - for example, a proxy or load balancer - alters the communication.
Properties:
Name Type Description error
Error the error that occured.
-
reconnect
-
Emitted when a disconnected session has successfully reconnected.
-
close
-
Emitted when the Stream has been closed through completion or the underlying session has been closed. No further events will be emitted after this.
-
error
-
Emitted when an error occurs in the Stream or in any of its listeners. No further events will be emitted after this.
Properties:
Name Type Description error
Error the error that occurred
-
close
-
Emitted when the subscription has been closed using ValueStream#close.
-
error
-
Emitted when the subscription request fails. No further events will be emitted after this.
Properties:
Name Type Description error
ErrorReason the error the subscription request failed with
-
open
-
Emitted when the subscription is initially opened, passing a reference to the subscription itself. This will only be fired once.
-
subscribe
-
Emitted when a topic that is selected by this ValueStream's topic selector is subscribed to by this session. Once subscribed,
value
update events may be received for this topic. The specification is a TopicSpecification instance that contains details about the topic.Properties:
Name Type Description topic
String the topic to which the subscription applies
specification
diffusion.topics.TopicSpecification instance that contains details about the topic
-
unsubscribe
-
Emitted when a topic that was previously subscribed, has been unsubscribed. No further update events will be received from this topic until subscribed again. Unsubscriptions may occur due to the topic being removed, or through calling Session#unsubscribe - an object containing the reason is provided.
Properties:
Name Type Description topic
String the topic to which the unsubscription applies
specification
diffusion.topics.TopicSpecification instance that contains details about the topic
reason
diffusion.topics.UnsubscribeReason the reason for the unsubscription
-
value
-
Emitted when an update has been received for a topic's value. Values will be provided as instances appropriate for the associated DataType this subscription was created for. Both the previous value and the new value are provided.
Properties:
Name Type Description topic
String the topic to which the update applies
specification
diffusion.topics.TopicSpecification instance that contains details about the topic
newValue
object the new value of the topic
oldValue
object the old value of the topic