Module

Phoenix

Package: purescript-phoenix
Repository: brandonhamilton/purescript-phoenix

#Socket Source

data Socket :: Type

A Phoenix Socket

#Channel Source

data Channel :: Type

A Phoenix Channel

#Push Source

data Push :: Type

A Phoenix Push object

#ConnectionState Source

data ConnectionState

Constructors

#Endpoint Source

type Endpoint = String

An Endpoint URL is just a string

#Topic Source

type Topic = String

#Event Source

type Event = String

#Status Source

type Status = String

#Message Source

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

#defaultSocketOptions Source

defaultSocketOptions :: Options Socket

Socket options

#timeout Source

timeout :: Option Socket Int

#heartbeatIntervalMs Source

heartbeatIntervalMs :: Option Socket Int

#reconnectAfterMs Source

reconnectAfterMs :: Option Socket (Int -> Int)

#params Source

params :: Option Socket Foreign

#newSocket Source

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

Create a new Phoenix Socket

#connect Source

connect :: Socket -> Effect Unit

Socket operations

#disconnect Source

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

#channel Source

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

#remove Source

remove :: Socket -> Channel -> Effect Unit

#sendHeartbeat Source

sendHeartbeat :: Socket -> Effect Unit

#flushSendBuffer Source

flushSendBuffer :: Socket -> Effect Unit

#makeRef Source

makeRef :: Socket -> Effect String

#protocol Source

protocol :: Socket -> Effect String

#endPointURL Source

endPointURL :: Socket -> Effect String

#isConnected Source

isConnected :: Socket -> Effect Boolean

#connectionState Source

connectionState :: Socket -> Effect ConnectionState

#onOpen Source

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

#onMessage Source

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

#onSocketError Source

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

#onSocketClose Source

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

#join Source

join :: Channel -> Effect Push

Channel operations

#push Source

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

#leave Source

leave :: Channel -> Effect Push

#rejoinUntilConnected Source

rejoinUntilConnected :: Channel -> Effect Unit

#canPush Source

canPush :: Channel -> Effect Boolean

#onChannelError Source

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

#onChannelClose Source

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

#on Source

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

Listen for messages on a channel

#off Source

off :: Channel -> Event -> Effect Unit

#send Source

send :: Push -> Effect Unit

Push operations

#receive Source

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

Modules: Phoenix