Module

Phoenix

#Socket

data Socket :: Type

A Phoenix Socket

#Channel

data Channel :: Type

A Phoenix Channel

#Push

data Push :: Type

A Phoenix Push object

#ConnectionState

data ConnectionState

Constructors

#Endpoint

type Endpoint = String

An Endpoint URL is just a string

#Topic

type Topic = String

#Event

type Event = String

#Status

type Status = String

#Message

type Message = { event :: Event, payload :: Foreign, ref :: String, topic :: Topic }

#defaultSocketOptions

defaultSocketOptions :: Options Socket

Socket options

#timeout

timeout :: Option Socket Int

#heartbeatIntervalMs

heartbeatIntervalMs :: Option Socket Int

#reconnectAfterMs

reconnectAfterMs :: Option Socket (Int -> Int)

#params

params :: Option Socket Foreign

#newSocket

newSocket :: Endpoint -> Options Socket -> Effect Socket

Create a new Phoenix Socket

#connect

connect :: Socket -> Effect Unit

Socket operations

#disconnect

disconnect :: forall a. Socket -> (Socket -> Effect a) -> Int -> String -> Effect Unit

#channel

channel :: Socket -> Topic -> Foreign -> Effect Channel

#remove

remove :: Socket -> Channel -> Effect Unit

#sendHeartbeat

sendHeartbeat :: Socket -> Effect Unit

#flushSendBuffer

flushSendBuffer :: Socket -> Effect Unit

#makeRef

makeRef :: Socket -> Effect String

#protocol

protocol :: Socket -> Effect String

#endPointURL

endPointURL :: Socket -> Effect String

#isConnected

isConnected :: Socket -> Effect Boolean

#connectionState

connectionState :: Socket -> Effect ConnectionState

#onOpen

onOpen :: forall a. Socket -> (Socket -> Effect a) -> Effect Unit

#onMessage

onMessage :: forall a. Socket -> (Socket -> Message -> Effect a) -> Effect Unit

#onSocketError

onSocketError :: forall a. Socket -> (Socket -> String -> Effect a) -> Effect Unit

#onSocketClose

onSocketClose :: forall a. Socket -> (Socket -> String -> Effect a) -> Effect Unit

#join

join :: Channel -> Effect Push

Channel operations

#push

push :: Channel -> Event -> Foreign -> Effect Push

#leave

leave :: Channel -> Effect Push

#rejoinUntilConnected

rejoinUntilConnected :: Channel -> Effect Unit

#canPush

canPush :: Channel -> Effect Boolean

#onChannelError

onChannelError :: forall a. Channel -> (Channel -> String -> Effect a) -> Effect Unit

#onChannelClose

onChannelClose :: forall a. Channel -> (Channel -> Event -> Effect a) -> Effect Unit

#on

on :: forall a. Channel -> Event -> (Channel -> Event -> Foreign -> Effect a) -> Effect Unit

Listen for messages on a channel

#off

off :: Channel -> Event -> Effect Unit

#send

send :: Push -> Effect Unit

Push operations

#receive

receive :: forall a. Push -> Status -> (Push -> Foreign -> Effect a) -> Effect Push