package async_websocket

You can search for identifiers within the package.

in-package search v0.2.0

async_websocket
- CHANGES
- LICENSE
- Library async_websocket
  - Websocket
    
    Opcode
    
    Connection_close_reason
    
    Frame_reader
    
    Frame
    
    Error
    
    Iobuf_writer
    
    Frame_reader
    
    Read_result
    
    Expert
    
    Iobuf_writer
    
    Content_reassembler
    
    Websocket_role
- Sources
  - async_websocket
    
    connection_close_reason.ml
    
    content_reassembler.ml
    
    crypto.ml
    
    frame.ml
    
    opcode.ml
    
    websocket.ml
    
    websocket__.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Frame_reader.Expert`Source

Sourcetype t

type partial_frame_handler =
  opcode:Opcode.t ->
  final:bool ->
  total_frame_payload_len:int ->
  payload_pos:int ->
  payload_fragment:(Core.read, Iobuf.seek) Iobuf.t ->
  masked:[ `Payload_was_masked | `Payload_was_not_masked ] ->
  unit

Sourceval create : partial_frame_handler:partial_frame_handler -> t

Source

val consume_frame_even_if_incomplete_payload : 
  t ->
  (Core.read_write, Iobuf.seek) Iobuf.t ->
  Read_result.t

consume_frame_even_if_incomplete_payload is useful for consuming payload data when: (i) the full frame payload is not available in the input iobuf (e.g. we haven't received the full frame yet); and (ii) the caller's ability to consume payload is limited (e.g. the downstream app buffer can't be resized)

It's meant to be invoked repeately on the same iobuf whenever there's more input data, or whenever the caller can handle more payload data.

package async_websocket

Module Frame_reader.ExpertSource

Module `Frame_reader.Expert`Source