Expand description
OKX WebSocket client.
Enable the websocket feature to use this module. The WebSocket client is
separate from the REST OkxClient, but reuses
Credentials, OkxRegion, and
the crate-wide Error type.
Re-exports§
pub use arg::Arg;pub use client::OkxWs;pub use client::OkxWsBuilder;pub use client::WsChannelGroup;pub use error::WsError;pub use event::Push;pub use event::WsChannelConnectionCount;pub use event::WsEvent;pub use event::WsNotice;pub use event::WsOperation;pub use request::AmendSpreadOrderRequest;pub use request::CancelSpreadOrderRequest;pub use request::ChannelRequest;pub use request::LoginArg;pub use request::LoginRequest;pub use request::MassCancelRequest;pub use request::MassCancelSpreadOrdersRequest;pub use request::OperationRequest;pub use request::PlaceSpreadOrderRequest;pub use response::AmendSpreadOrderResponse;pub use response::CancelSpreadOrderResponse;pub use response::ChannelAcknowledgement;pub use response::ChannelConnectionCountResponse;pub use response::LoginAcknowledgement;pub use response::MassCancelSpreadOrdersResponse;pub use response::NoticeResponse;pub use response::OperationResponse;pub use response::PlaceSpreadOrderResponse;pub use response::PushResponse;pub use response::ResponseExtraFields;
Modules§
- arg
- WebSocket subscription arguments.
- channels
- WebSocket channel argument helpers.
- client
- WebSocket client and connection lifecycle.
- error
- WebSocket-layer error type.
- event
- WebSocket event and response decoding.
- model
- Typed response rows for OKX WebSocket channels.
- ops
- WebSocket operation helpers.
- request
- Typed OKX WebSocket request bodies.
- response
- Typed top-level OKX WebSocket response bodies.
Structs§
- Tungstenite
Conn - WebSocket connection backed by
tokio-tungstenite. - Tungstenite
Connector - Default WebSocket connector backed by
tokio-tungstenite.
Enums§
- WsFrame
- A WebSocket frame handled by the OKX WebSocket client.
Traits§
- WsConn
- A full-duplex WebSocket connection.
- WsConnector
- Creates WebSocket connections for an OKX WebSocket endpoint URL.