Pushest v0.2.2 API Reference

Modules

Pushest is a Pusher library leveraging Elixir/OTP to combine server and client-side Pusher features. Abstracts un/subscription, client-side triggers, private/presence channel authorizations. Keeps track of subscribed channels and users presence when subscribed to a presence channel. Pushest is meant to be used in your module where you can define callbacks for events you’re interested in

GenServer responsible for communication with Pusher via REST API endpoint. This module is meant to be used internally as part of the Pushest application

Structure representing a Frame being passed between Pushest and Pusher server. Includes methods constructing Frame structure for various pusher events. This module handles encode/decode actions for a Frame

Structure representing whole App state being held in GenServer process

Structure used to construct URL for Pusher server

Returns current unix timestamp or static one based on current environment

Various Api-scoped utilities

Returns :gun or Pushest.FakeClient based on current environment

Structure representing main Pusher options which are passed via Pushest initializating methods

Routes calls/cast from a module using Pushest to either Socket or Api GenServers

GenServer responsible for communication with Pusher via WebSockets. This module is meant to be used internally as part of the Pushest application

Structure representing a Frame being passed between Pushest and Pusher server. Includes methods constructing Frame structure for various pusher events. This module handles encode/decode actions for a Frame

Structure representing presence information, connected user IDs and data of them

Structure representing a basic socket informations which are being sent when connection with Pusher server is estabilished. This module handles decode action for a SocketInfo

Structure representing whole App state being held in GenServer process

Structure representing a specific data payload being sent as part of a subscription event

Structure used to construct URL for Pusher server

Various Socket-scoped utilities

Supervises Api and Socket processes, handles generation of proper configuration for those modules

Top-level utility/helpers module