gleam_gun/websocket

Types

ConnectError

The URI of the websocket server to connect to

pub type ConnectError {
  ConnectionRefused(status: Int, headers: List(Header))
  ConnectionFailed(reason: Dynamic)
}

Constructors

ConnectionRefused(status: Int, headers: List(Header))

```
ConnectionFailed(reason: Dynamic)
```

Connection

</>

pub opaque type Connection

ConnectionOpts

</>

pub type ConnectionOpts {
  Transport(Atom)
  TransportOpts(List(ConnectionOptsTransportOpts))
}

Constructors

```
Transport(Atom)
```

TransportOpts(List(ConnectionOptsTransportOpts))

ConnectionOptsTransportOpts

</>

pub type ConnectionOptsTransportOpts {
  Verify(Atom)
}

Constructors

```
Verify(Atom)
```

Frame

</>

pub type Frame {
  Close
  Text(String)
  Binary(BitString)
}

Constructors

```
Close
```
```
Text(String)
```
```
Binary(BitString)
```

Functions

close

</>

pub fn close(conn: Connection) -> Nil

connect

</>

pub fn connect(hostname: String, path: String, port: Int, headers: List(
    #(String, String),
  ), opts: List(ConnectionOpts)) -> Result(
  Connection,
  ConnectError,
)

receive

</>

pub external fn receive(
  from: Connection,
  within: Int,
) -> Result(Frame, Nil)

send

</>

pub fn send(to conn: Connection, this message: String) -> Nil

send_binary

</>

pub fn send_binary(to conn: Connection, this message: BitString) -> Nil

send_binary_builder

</>

pub fn send_binary_builder(to conn: Connection, this message: BitBuilder) -> Nil

send_builder

</>

pub fn send_builder(to conn: Connection, this message: StringBuilder) -> Nil