pixie v0.3.9 API Reference
Modules
Starts a stand-alone instance of Pixie. Probably only good for development and testing
This module defines sensible defaults for all user configurable options, and
provides a few helper functions, such as publish
and subscribe
Used to implement the persistence backend for Pixie
This is the default persistence backend for Pixie, which stores data in ETS tables, which means it will only persist as long as this process is running
This process keeps track of all channel subscriptions
This process keeps track of all client subscriptions
This process manages the generation and removal of client processes
This process keeps track of any messages waiting to be delivered to clients
This process manages the generation and removal of unique identifiers. These are mostly used for client ID’s, but can be other stuff too
This process manages the generation and removal of client processes
Use this extension for debugging only - it logs every event to Logger
which has the unfortunate side effect of exploding your VM when there’s
logs of traffic
This module defines the event struct, which is created for all incoming
messages from clients and passed into the incoming
function of extensions
Used to implement Bayeux extensions, which can be used to filter or change incoming messages and the responses sent back to the client
Represents an in-VM subscription to a Bayeux channel
This module handles dispatch of incoming messages to their corresponding message structs
Convert an incoming connect message into a struct
Convert an incoming disconnect message into a struct
Convert an incomikng handshake message into a struct
Convert an incoming message publication into a struct
Convert an incoming subscription request into a struct
Convert an incoming unsubscription request into a struct
Allows you to monitor various events within Pixie
This module handles creation of appropriate responses to client messages
Convert an incoming Pixie.Message.Connect
into a response
Convert an incoming Pixie.Message.Disconnect
into a response
Convert an incoming Pixie.Message.Handshake
into a response
Convert an incoming Pixie.Message.Publish
into a response
Convert an incoming Pixie.Message.Subscribe
into a response
Convert an incoming Pixie.Message.Unsubscribe
into a response
Use this extension if you wish to ensure that only subscribed clients can publish to channels
Parses various types of broken request body