mist/websocket

Types

Frame

pub type Frame {
  CloseFrame(payload_length: Int, payload: BitString)
  TextFrame(payload_length: Int, payload: BitString)
  BinaryFrame(payload_length: Int, payload: BitString)
  PingFrame(payload_length: Int, payload: BitString)
  PongFrame(payload_length: Int, payload: BitString)
}

Constructors

CloseFrame(payload_length: Int, payload: BitString)

TextFrame(payload_length: Int, payload: BitString)

BinaryFrame(payload_length: Int, payload: BitString)

PingFrame(payload_length: Int, payload: BitString)

PongFrame(payload_length: Int, payload: BitString)

Handler

</>

pub type Handler =
  fn(Message, Sender(HandlerMessage)) -> Result(Nil, Nil)

Message

</>

pub type Message {
  BinaryMessage(data: BitString)
  TextMessage(data: String)
}

Constructors

```
BinaryMessage(data: BitString)
```
```
TextMessage(data: String)
```

ShaHash

</>

pub type ShaHash {
  Sha
}

Constructors

```
Sha
```

WebsocketHandler

</>

pub type WebsocketHandler {
  WebsocketHandler(
    on_close: Option(fn(Sender(tcp.HandlerMessage)) -> Nil),
    on_init: Option(fn(Sender(tcp.HandlerMessage)) -> Nil),
    handler: Handler,
  )
}

Constructors

WebsocketHandler(
  on_close: Option(fn(Sender(tcp.HandlerMessage)) -> Nil),
  on_init: Option(fn(Sender(tcp.HandlerMessage)) -> Nil),
  handler: Handler,
)

Functions

base64_encode

</>

pub external fn base64_encode(data: String) -> String

crypto_hash

</>

pub external fn crypto_hash(
  hash: ShaHash,
  data: String,
) -> String

echo_handler

</>

pub fn echo_handler(message: Message, sender: Sender(
    HandlerMessage,
  )) -> Result(Nil, Nil)

frame_from_message

</>

pub fn frame_from_message(socket: Socket, message: BitString) -> Result(
  Frame,
  Nil,
)

frame_to_bit_builder

</>

pub fn frame_to_bit_builder(frame: Frame) -> BitBuilder

on_close

</>

pub fn on_close(handler: WebsocketHandler, func: fn(
    Sender(HandlerMessage),
  ) -> Nil) -> WebsocketHandler

on_init

</>

pub fn on_init(handler: WebsocketHandler, func: fn(
    Sender(HandlerMessage),
  ) -> Nil) -> WebsocketHandler

parse_key

</>

pub fn parse_key(key: String) -> String

send

</>

pub fn send(message: Message, sender: Sender(HandlerMessage)) -> Nil

Helper to encapsulate the logic to send a provided message over the WebSocket

upgrade

</>

pub fn upgrade(socket: Socket, req: Request(BitString)) -> Result(
  Nil,
  Nil,
)

upgrade_socket

</>

pub fn upgrade_socket(req: Request(BitString)) -> Result(
  Response(BitBuilder),
  Request(BitString),
)

with_handler

</>

pub fn with_handler(func: fn(Message, Sender(HandlerMessage)) ->
    Result(Nil, Nil)) -> WebsocketHandler