gramps/websocket

Types

ControlFrame

pub type ControlFrame {
  CloseFrame(payload_length: Int, payload: BitArray)
  PingFrame(payload_length: Int, payload: BitArray)
  PongFrame(payload_length: Int, payload: BitArray)
}

Constructors

CloseFrame(payload_length: Int, payload: BitArray)

PingFrame(payload_length: Int, payload: BitArray)

PongFrame(payload_length: Int, payload: BitArray)

DataFrame

</>

pub type DataFrame {
  TextFrame(payload_length: Int, payload: BitArray)
  BinaryFrame(payload_length: Int, payload: BitArray)
}

Constructors

TextFrame(payload_length: Int, payload: BitArray)

BinaryFrame(payload_length: Int, payload: BitArray)

Frame

</>

pub type Frame {
  Data(DataFrame)
  Control(ControlFrame)
  Continuation(length: Int, payload: BitArray)
}

Constructors

```
Data(DataFrame)
```
```
Control(ControlFrame)
```

Continuation(length: Int, payload: BitArray)

FrameParseError

</>

pub type FrameParseError {
  NeedMoreData(BitArray)
  InvalidFrame
}

Constructors

```
NeedMoreData(BitArray)
```
```
InvalidFrame
```

ParsedFrame

</>

pub type ParsedFrame {
  Complete(Frame)
  Incomplete(Frame)
}

Constructors

```
Complete(Frame)
```
```
Incomplete(Frame)
```

Constants

client_key

</>

pub const client_key: String

Functions

aggregate_frames

</>

pub fn aggregate_frames(
  frames: List(ParsedFrame),
  previous: Option(Frame),
  joined: List(Frame),
) -> Result(List(Frame), Nil)

compressed_frame_to_bytes_tree

</>

pub fn compressed_frame_to_bytes_tree(
  frame: Frame,
  context: Context,
  mask: Option(BitArray),
) -> BytesTree

frame_from_message

</>

pub fn frame_from_message(
  message: BitArray,
  context: Option(Context),
) -> Result(#(ParsedFrame, BitArray), FrameParseError)

frame_to_bytes_tree

</>

pub fn frame_to_bytes_tree(
  frame: Frame,
  mask: Option(BitArray),
) -> BytesTree

get_messages

</>

pub fn get_messages(
  data: BitArray,
  frames: List(ParsedFrame),
  context: Option(Context),
) -> #(List(ParsedFrame), BitArray)

has_deflate

</>

pub fn has_deflate(extensions: List(String)) -> Bool

parse_websocket_key

</>

pub fn parse_websocket_key(key: String) -> String

to_binary_frame

</>

pub fn to_binary_frame(
  data: BitArray,
  context: Option(Context),
  mask: Option(BitArray),
) -> BytesTree

to_text_frame

</>

pub fn to_text_frame(
  data: String,
  context: Option(Context),
  mask: Option(BitArray),
) -> BytesTree