spinify library
Classes
- Spinify Client
- Spinify client for Centrifuge.
- SpinifyChannelPresence Event
- Channel presence. Join / Leave events.
- SpinifyChannelPush Event
- Base class for all channel push events.
- SpinifyClientInfo Entity
- Client information.
- SpinifyClientSubscription Subscription
- Centrifuge client-side subscription representation.
- SpinifyConfig Client Entity
- Spinify client common options.
- SpinifyConnect Event
- Connect push from Centrifugo server.
- SpinifyDisconnect Event
- Disconnect push from Centrifugo server.
- SpinifyEvent Event
- Base class for all channel events.
- SpinifyHistory Entity
- History
- SpinifyJoin Event
- Channel presence. Join / Leave events.
- SpinifyJWT Entity
- A JWT token consists of three parts: the header, the payload, and the signature or encryption data. The first two elements are JSON objects of a specific structure. The third element is calculated based on the first two and depends on the chosen algorithm (in the case of using an unsigned JWT, it can be omitted). Tokens can be re-encoded into a compact representation (JWS/JWE Compact Serialization): the header and payload are subjected to Base64-URL encoding, after which the signature is added, and all three elements are separated by periods (".").
- SpinifyLeave Event
- Channel presence. Join / Leave events.
- SpinifyMessage Event
- Message push from Centrifugo server.
- SpinifyMetrics Entity Metrics
- WebSocket metrics.
- SpinifyObserver Client
- An interface for observing the behavior of Spinify instances.
- SpinifyPresence Entity
- Presence
- SpinifyPresenceStats Entity
- Presence stats
- SpinifyPublication Event
- Publication context
- SpinifyPushesStream Client Event Subscription
- Stream of received pushes from Centrifugo server for a channel.
- SpinifyRefresh Event
- Refresh push from Centrifugo server.
- SpinifyServerSubscription Subscription
- Centrifuge server-side subscription representation.
- SpinifyState Client Entity
- Spinify client connection states
- SpinifyState$Closed Client Entity
- Permanently closed
- SpinifyState$Connected Client Entity
- Connected
- SpinifyState$Connecting Client Entity
- Connecting
- SpinifyState$Disconnected Client Entity
- Disconnected Client should handle disconnect advices from server. In websocket case disconnect advice is sent in CLOSE Websocket frame. Disconnect advice contains uint32 code and human-readable string reason.
- SpinifyStatesStream Client Entity
- Stream of Spinify's SpinifyState changes.
- SpinifySubscribe Event
- Subscribe push from Centrifugo server.
- SpinifySubscription Subscription
- Spinify subscription interface.
- SpinifySubscriptionConfig Entity Subscription
- Subscription common options
- SpinifySubscriptionState Entity Subscription
- Subscription has 3 states:
- SpinifySubscriptionState$Subscribed Entity Subscription
- Subscribed state
- SpinifySubscriptionState$Subscribing Entity Subscription
- Subscribing state
- SpinifySubscriptionState$Unsubscribed Entity Subscription
- Unsubscribed state
- SpinifySubscriptionStateStream Entity Subscription
- Stream of Spinify's SpinifySubscriptionState changes.
- SpinifyUnsubscribe Event
- Unsubscribe push from Centrifugo server.
- SubcibedOnChannel Entity Subscription
- Subscribed on channel message.
Typedefs
-
SpinifyConnectionPayloadCallback
= FutureOr<
List< Function() Client Entityint> ?> - Callback to get initial connection payload data.
-
SpinifyStateMatch<
R, S extends SpinifyState> = R Function(S state) Entity - Pattern matching for SpinifyState.
- SpinifyStreamPosition = ({String epoch, Int64 offset}) Entity
- Stream position.
-
SpinifySubscribePayloadCallback
= FutureOr<
List< Function() Entity Subscriptionint> ?> - Callback to set subscription payload data.
- SpinifySubscriptionCount = ({int subscribed, int subscribing, int total, int unsubscribed}) Entity Metrics
- Subscription count
-
SpinifySubscriptionStateMatch<
R, S extends SpinifySubscriptionState> = R Function(S state) Entity - Pattern matching for SpinifySubscriptionState.
- SpinifySubscriptionToken = String Entity Subscription
- Token used for subscription.
-
SpinifySubscriptionTokenCallback
= FutureOr<
SpinifySubscriptionToken?> Function() Entity Subscription - Callback to get token for subscription. If method returns null then subscription will be established without token.
- SpinifyToken = String Client Entity
- Token used for authentication
-
SpinifyTokenCallback
= FutureOr<
SpinifyToken?> Function() Client Entity - Callback to get/refresh tokens This callback is used for initial connection and for refreshing expired tokens.
Exceptions / Errors
- SpinifyConnectionException Exception
- Spinify exception.
- SpinifyException Exception
- Spinify exception.
- SpinifyFetchException Exception
- Spinify exception.
- SpinifyPingException Exception
- Spinify exception.
- SpinifyRefreshException Exception
- Spinify exception.
- SpinifyReplyException Exception
- Spinify exception.
- SpinifySendException Exception
- Spinify exception.
- SpinifySubscriptionException Exception
- Spinify exception.