WebSocket

data WEBSOCKET :: Effect

The effect associated with websocket connections.

data WebSocket :: Type

A reference to a WebSocket object.

newWebSocket :: forall eff. URL -> Array Protocol -> Eff (err :: EXCEPTION, ws :: WEBSOCKET | eff) Connection

Initiate a websocket connection.

runMessageEvent :: MessageEvent -> Message

newtype Connection

• binaryType -- The type of binary data being transmitted by the connection.
• bufferedAmount -- The number of bytes of data that have been queued using calls to send but not yet transmitted to the network. This value does not reset to zero when the connection is closed; if you keep calling send, this will continue to climb.
• onclose -- An event listener to be called when the Connection's readyState changes to Closed.
• onerror -- An event listener to be called when an error occurs.
• onmessage -- An event listener to be called when a message is received from the server.
• onopen -- An event listener to be called when the Connection's readyState changes to Open; this indicates that the connection is ready to send and receive data.
• protocol -- A string indicating the name of the sub-protocol the server selected.
• readyState -- The current state of the connection.
• url -- The URL as resolved by during construction. This is always an absolute URL.
• close -- Closes the connection or connection attempt, if any. If the connection is already CLOSED, this method does nothing. If Code isn't specified a default value of 1000 (indicating a normal "transaction complete" closure) is assumed
• send -- Transmits data to the server.
• socket -- Reference to closured WebSocket object.

Constructors

• Connection { binaryType :: forall eff. Var (ws :: WEBSOCKET | eff) BinaryType, bufferedAmount :: forall eff. GettableVar (ws :: WEBSOCKET | eff) BufferedAmount, close :: forall eff. Eff (err :: EXCEPTION, ws :: WEBSOCKET | eff) Unit, close' :: forall eff. Code -> Maybe Reason -> Eff (err :: EXCEPTION, ws :: WEBSOCKET | eff) Unit, onclose :: forall handlerEff eff. SettableVar (ws :: WEBSOCKET | eff) (CloseEvent -> Eff handlerEff Unit), onerror :: forall handlerEff eff. SettableVar (ws :: WEBSOCKET | eff) (Event -> Eff handlerEff Unit), onmessage :: forall handlerEff eff. SettableVar (ws :: WEBSOCKET | eff) (MessageEvent -> Eff handlerEff Unit), onopen :: forall handlerEff eff. SettableVar (ws :: WEBSOCKET | eff) (Event -> Eff handlerEff Unit), protocol :: forall eff. Var (ws :: WEBSOCKET | eff) Protocol, readyState :: forall eff. GettableVar (ws :: WEBSOCKET | eff) ReadyState, send :: forall eff. Message -> Eff (err :: EXCEPTION, ws :: WEBSOCKET | eff) Unit, socket :: forall eff. GettableVar (ws :: WEBSOCKET | eff) WebSocket, url :: forall eff. GettableVar (ws :: WEBSOCKET | eff) URL }

data BinaryType

The type of binary data being transmitted by the connection.

Constructors

• Blob
• ArrayBuffer

newtype BufferedAmount

The number of bytes of data that have been buffered (queued but not yet transmitted)

Instances

• Generic BufferedAmount
• Eq BufferedAmount
• Ord BufferedAmount

runBufferedAmount :: BufferedAmount -> Int

newtype Protocol

A string indicating the name of the sub-protocol.

Constructors

• Protocol String

Instances

• Generic Protocol
• Eq Protocol
• Ord Protocol

runProtocol :: Protocol -> String

data ReadyState

State of the connection.

Constructors

• Connecting
• Open
• Closing
• Closed

Instances

• Generic ReadyState
• Eq ReadyState
• Ord ReadyState
• Show ReadyState
• Bounded ReadyState
• BoundedEnum ReadyState
• Enum ReadyState

newtype Code

Should be either equal to 1000 (indicating normal closure) or in the range of 3000-4999.

Constructors

• Code Int

Instances

• Generic Code
• Eq Code
• Ord Code

runCode :: Code -> Int

newtype Reason

A human-readable string explaining why the connection is closing. This string must be no longer than 123 bytes of UTF-8 text (not characters).

Constructors

• Reason String

Instances

• Generic Reason
• Generic Reason

runReason :: Reason -> String

newtype URL

A synonym for URL strings.

Constructors

• URL String

Instances

• Generic URL

runURL :: URL -> String

newtype Message

A synonym for message strings.

Constructors

• Message String

runMessage :: Message -> String