Copyright	(c) 2016 Michael Walker
License	MIT
Maintainer	Michael Walker <[email protected]>
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

Network.Pusher.WebSockets

Contents

Pusher
- Connection
Re-exports

Description

Pusher has two APIs: the REST API and the websocket API. The websocket API, which is what this package implements, is used by clients primarily to subscribe to channels and receive events. This library encourages a callback-style approach to Pusher, where the pusherWithOptions function is used to subscribe to some channels and bind some event handlers, and then block until the connection is closed.

A small example, which simply prints all received events:

let key = "your-key"
let channels = ["your", "channels"]

-- Connect to Pusher with your key, SSL, and the us-east-1 region,
-- and do some stuff.
pusherWithOptions (defaultOptions key) $ do
  -- Subscribe to all the channels
  mapM_ subscribe channels

  -- Bind an event handler for all events on all channels which
  -- prints the received JSON.
  bindAll Nothing (liftIO . print)

  -- Wait for user input and then close the connection.
  liftIO (void getLine)
  disconnectBlocking

See https://pusher.com/docs/pusher_protocol for details of the protocol.

Synopsis

Pusher

data PusherClient a Source #

A value of type PusherClient a is a computation with access to a connection to Pusher which, when executed, may perform Pusher-specific actions such as subscribing to channels and receiving events, as well as arbitrary I/O.

Instances

Monad PusherClient Source #
Methods (>>=) :: PusherClient a -> (a -> PusherClient b) -> PusherClient b # (>>) :: PusherClient a -> PusherClient b -> PusherClient b # return :: a -> PusherClient a # fail :: String -> PusherClient a #
Functor PusherClient Source #
Methods fmap :: (a -> b) -> PusherClient a -> PusherClient b # (<$) :: a -> PusherClient b -> PusherClient a #
Applicative PusherClient Source #
Methods pure :: a -> PusherClient a # (<>) :: PusherClient (a -> b) -> PusherClient a -> PusherClient b # (>) :: PusherClient a -> PusherClient b -> PusherClient b # (<*) :: PusherClient a -> PusherClient b -> PusherClient a #
MonadIO PusherClient Source #
Methods liftIO :: IO a -> PusherClient a #

data PusherClosed Source #

Thrown if attempting to communicate with Pusher after the connection has been closed.

If the server closed the connection, the error code is included. See the 4000-4099 error codes on https://pusher.com/docs/pusher_protocol.

Constructors

PusherClosed (Maybe Word16)

Instances

Eq PusherClosed Source #
Methods (==) :: PusherClosed -> PusherClosed -> Bool # (/=) :: PusherClosed -> PusherClosed -> Bool #
Ord PusherClosed Source #
Methods compare :: PusherClosed -> PusherClosed -> Ordering # (<) :: PusherClosed -> PusherClosed -> Bool # (<=) :: PusherClosed -> PusherClosed -> Bool # (>) :: PusherClosed -> PusherClosed -> Bool # (>=) :: PusherClosed -> PusherClosed -> Bool # max :: PusherClosed -> PusherClosed -> PusherClosed # min :: PusherClosed -> PusherClosed -> PusherClosed #
Read PusherClosed Source #
Methods readsPrec :: Int -> ReadS PusherClosed # readList :: ReadS [PusherClosed] # readPrec :: ReadPrec PusherClosed # readListPrec :: ReadPrec [PusherClosed] #
Show PusherClosed Source #
Methods showsPrec :: Int -> PusherClosed -> ShowS # show :: PusherClosed -> String # showList :: [PusherClosed] -> ShowS #
Exception PusherClosed Source #
Methods toException :: PusherClosed -> SomeException # fromException :: SomeException -> Maybe PusherClosed # displayException :: PusherClosed -> String #

newtype AppKey Source #

Your application's API key.

Constructors

AppKey String

Instances

Eq AppKey Source #
Methods (==) :: AppKey -> AppKey -> Bool # (/=) :: AppKey -> AppKey -> Bool #
Ord AppKey Source #
Methods compare :: AppKey -> AppKey -> Ordering # (<) :: AppKey -> AppKey -> Bool # (<=) :: AppKey -> AppKey -> Bool # (>) :: AppKey -> AppKey -> Bool # (>=) :: AppKey -> AppKey -> Bool # max :: AppKey -> AppKey -> AppKey # min :: AppKey -> AppKey -> AppKey #
Read AppKey Source #
Methods readsPrec :: Int -> ReadS AppKey # readList :: ReadS [AppKey] # readPrec :: ReadPrec AppKey # readListPrec :: ReadPrec [AppKey] #
Show AppKey Source #
Methods showsPrec :: Int -> AppKey -> ShowS # show :: AppKey -> String # showList :: [AppKey] -> ShowS #
IsString AppKey Source #
Methods fromString :: String -> AppKey #
NFData AppKey Source #
Methods rnf :: AppKey -> () #

data Options Source #

Constructors

Options

Fields

appKey :: AppKey
The application key.
encrypted :: Bool
If the connection should be made over an encrypted connection. Defaults to True.
authorisationURL :: Maybe String
The URL which will return the authentication signature needed for private and presence channels. If not given, private and presence channels cannot be used. Defaults to Nothing.
cluster :: Cluster
Allows connecting to a different cluster by setting up correct hostnames for the connection. This parameter is mandatory when the app is created in a different cluster to the default us-east-1. Defaults to MT1.
pusherURL :: Maybe (HostName, PortNumber, String)
The host, port, and path to use instead of the standard Pusher servers. If set, the cluster is ignored. Defaults to Nothing.

Instances

Eq Options Source #
Methods (==) :: Options -> Options -> Bool # (/=) :: Options -> Options -> Bool #
Ord Options Source #
Methods compare :: Options -> Options -> Ordering # (<) :: Options -> Options -> Bool # (<=) :: Options -> Options -> Bool # (>) :: Options -> Options -> Bool # (>=) :: Options -> Options -> Bool # max :: Options -> Options -> Options # min :: Options -> Options -> Options #
Show Options Source #
Methods showsPrec :: Int -> Options -> ShowS # show :: Options -> String # showList :: [Options] -> ShowS #
NFData Options Source #
Methods rnf :: Options -> () #

data Cluster Source #

Clusters correspond to geographical regions where apps can be assigned to.

Constructors

MT1	The us-east-1 cluster.
EU	The eu-west-1 cluster.
AP1	The ap-southeast-1 cluster.

Instances

Bounded Cluster Source #
Methods minBound :: Cluster # maxBound :: Cluster #
Enum Cluster Source #
Methods succ :: Cluster -> Cluster # pred :: Cluster -> Cluster # toEnum :: Int -> Cluster # fromEnum :: Cluster -> Int # enumFrom :: Cluster -> [Cluster] # enumFromThen :: Cluster -> Cluster -> [Cluster] # enumFromTo :: Cluster -> Cluster -> [Cluster] # enumFromThenTo :: Cluster -> Cluster -> Cluster -> [Cluster] #
Eq Cluster Source #
Methods (==) :: Cluster -> Cluster -> Bool # (/=) :: Cluster -> Cluster -> Bool #
Ord Cluster Source #
Methods compare :: Cluster -> Cluster -> Ordering # (<) :: Cluster -> Cluster -> Bool # (<=) :: Cluster -> Cluster -> Bool # (>) :: Cluster -> Cluster -> Bool # (>=) :: Cluster -> Cluster -> Bool # max :: Cluster -> Cluster -> Cluster # min :: Cluster -> Cluster -> Cluster #
Read Cluster Source #
Methods readsPrec :: Int -> ReadS Cluster # readList :: ReadS [Cluster] # readPrec :: ReadPrec Cluster # readListPrec :: ReadPrec [Cluster] #
Show Cluster Source #
Methods showsPrec :: Int -> Cluster -> ShowS # show :: Cluster -> String # showList :: [Cluster] -> ShowS #
NFData Cluster Source #
Methods rnf :: Cluster -> () #

pusherWithOptions :: Options -> PusherClient a -> IO a Source #

Connect to Pusher.

This does NOT automatically disconnect from Pusher when the supplied action terminates, so either the action will need to call disconnect or disconnectBlocking as the last thing it does, or one of the event handlers will need to do so eventually.

defaultOptions :: AppKey -> Options Source #

See Options field documentation for what is set here.

Connection

data ConnectionState Source #

The state of the connection. Events are sent when the state is changed.

Constructors

Initialized	Initial state. No event is emitted.
Connecting	Trying to connect. This state will also be entered when trying to reconnect after a connection failure. Emits the `"connecting"` event.
Connected	The connection is established and authenticated with your app. Emits the `"connected"` event.
Unavailable	The connection is temporarily unavailable. The network connection is down, the server is down, or something is blocking the connection. Emits the `"unavailable"` event and then enters the `Connecting` state again.
Disconnected (Maybe Word16)	The connection has been closed by the client, or the server indicated an error which cannot be resolved by reconnecting with the same settings. If the server closed the connection, the error code is included. See the 4000-4099 error codes on https://pusher.com/docs/pusher_protocol. Emits the `"disconnected"` event and then kills all forked threads.

Instances

Eq ConnectionState Source #
Methods (==) :: ConnectionState -> ConnectionState -> Bool # (/=) :: ConnectionState -> ConnectionState -> Bool #
Ord ConnectionState Source #
Methods compare :: ConnectionState -> ConnectionState -> Ordering # (<) :: ConnectionState -> ConnectionState -> Bool # (<=) :: ConnectionState -> ConnectionState -> Bool # (>) :: ConnectionState -> ConnectionState -> Bool # (>=) :: ConnectionState -> ConnectionState -> Bool # max :: ConnectionState -> ConnectionState -> ConnectionState # min :: ConnectionState -> ConnectionState -> ConnectionState #
Read ConnectionState Source #
Methods readsPrec :: Int -> ReadS ConnectionState # readList :: ReadS [ConnectionState] # readPrec :: ReadPrec ConnectionState # readListPrec :: ReadPrec [ConnectionState] #
Show ConnectionState Source #
Methods showsPrec :: Int -> ConnectionState -> ShowS # show :: ConnectionState -> String # showList :: [ConnectionState] -> ShowS #

connectionState :: PusherClient ConnectionState Source #

Get the connection state.

disconnect :: PusherClient () Source #

Gracefully close the connection. The connection will remain open and events will continue to be processed until the server accepts the request.

disconnectBlocking :: PusherClient () Source #

Like disconnect, but block until the connection is actually closed.

blockUntilDisconnected :: PusherClient () Source #

Block until the connection is closed (but do not initiate a disconnect).

This is useful if you run pusherWithOptions in the main thread to prevent the program from terminating until one of your event handlers decides to disconnect.

Re-exports

module Network.Pusher.WebSockets.Channel

module Network.Pusher.WebSockets.Event

module Network.Pusher.WebSockets.Util