Header menu logo FSharp.ATProto

Firehose Module

Functions and values

Function or value Description

buildUri options

Full Usage: buildUri options

Parameters:
Returns: Uri

Build the WebSocket URI from options.

options : FirehoseOptions
Returns: Uri

defaultOptions

Full Usage: defaultOptions

Returns: FirehoseOptions

Default firehose options pointing at the main Bluesky relay.

Returns: FirehoseOptions

parseFrame data count

Full Usage: parseFrame data count

Parameters:
    data : byte[]
    count : int

Returns: Result<FirehoseEvent, StreamError>

Parse a raw firehose WebSocket binary frame into a FirehoseEvent.

data : byte[]
count : int
Returns: Result<FirehoseEvent, StreamError>

subscribe options ct

Full Usage: subscribe options ct

Parameters:
Returns: IAsyncEnumerable<Result<FirehoseEvent, StreamError>>

Subscribe to the AT Protocol firehose. Returns an IAsyncEnumerable that yields parsed events until the connection closes or the CancellationToken is triggered.

options : FirehoseOptions
ct : CancellationToken
Returns: IAsyncEnumerable<Result<FirehoseEvent, StreamError>>

Type something to start searching.