connection

WebSocket connection management via stratus actors.

Handles public and private (authenticated) connections with automatic message routing based on type / method fields in incoming JSON.

Types

WsCommand

</>

User message type for the WebSocket actor.

pub type WsCommand {
  Subscribe(
    List(subscription.Subscription),
    subscription.WsFormat,
  )
  ListSubscriptions
}

Constructors

Subscribe(List(subscription.Subscription), subscription.WsFormat)

```
ListSubscriptions
```

WsHandle

</>

Handle returned from connecting to a WebSocket.

pub type WsHandle =
  process.Subject(stratus.InternalMessage(WsCommand))

WsMessage

</>

Decoded WebSocket message.

pub type WsMessage {
  TickerMsg(subscription.TickerData)
  TradeMsg(subscription.TradeData)
  OrderbookMsg(subscription.OrderbookData)
  SubscriptionListMsg(subscription.ListSubscriptionsResponse)
  StatusMsg(String)
  ErrorMsg(name: String, message: String)
  RawMsg(String)
}

Constructors

```
TickerMsg(subscription.TickerData)
```
```
TradeMsg(subscription.TradeData)
```

OrderbookMsg(subscription.OrderbookData)

SubscriptionListMsg(subscription.ListSubscriptionsResponse)

```
StatusMsg(String)
```
```
ErrorMsg(name: String, message: String)
```
```
RawMsg(String)
```

WsState

</>

Internal WebSocket state.

pub type WsState(user_state) {
  WsState(
    on_message: fn(user_state, WsMessage) -> user_state,
    user_state: user_state,
  )
}

Constructors

WsState(
  on_message: fn(user_state, WsMessage) -> user_state,
  user_state: user_state,
)

Values

connect_private

</>

pub fn connect_private(
  credentials creds: auth.Credentials,
  state user_state: user_state,
  on_message handler: fn(user_state, WsMessage) -> user_state,
) -> Result(
  process.Subject(stratus.InternalMessage(WsCommand)),
  stratus.InitializationError,
)

Connect to the private WebSocket with authentication.

connect_public

</>

pub fn connect_public(
  state user_state: user_state,
  on_message handler: fn(user_state, WsMessage) -> user_state,
) -> Result(
  process.Subject(stratus.InternalMessage(WsCommand)),
  stratus.InitializationError,
)

Connect to the public WebSocket.

list_subscriptions

</>

pub fn list_subscriptions(
  conn: process.Subject(stratus.InternalMessage(WsCommand)),
) -> Nil

Query the list of active subscriptions on the WebSocket.

</>

pub fn subscribe(
  conn: process.Subject(stratus.InternalMessage(WsCommand)),
  subscriptions: List(subscription.Subscription),
  format: subscription.WsFormat,
) -> Nil

Send a subscription request over the WebSocket.