Skip to main content

CwsSession

Struct CwsSession 

Source
pub struct CwsSession { /* private fields */ }
Expand description

An authorized connection to the trading channel.

§Examples

use std::time::Duration;
use serde_json::json;
use brokapi_alor_protocol::http::client::AlorHttpClient;
use brokapi_alor_protocol::ws::cws::{CwsSession, opcodes};

let http = AlorHttpClient::new(cfg)?;
let cws = CwsSession::connect(http, Duration::from_secs(5)).await?;
let reply = cws
    .command(opcodes::CREATE_LIMIT, json!({
        "side": "buy", "quantity": 1, "price": 100.0,
        "instrument": {"symbol": "SBER", "exchange": "MOEX", "instrumentGroup": "TQBR"},
        "user": {"portfolio": "D00001"},
    }))
    .await?;
assert_eq!(reply.code, 200);
assert!(reply.order_number.is_some());

Implementations§

Source§

impl CwsSession

Source

pub async fn connect( http: AlorHttpClient, answer_timeout: Duration, ) -> Result<Self, AlorApiError>

Opens the connection and authorizes it. answer_timeout is how long a command waits for its answer.

§Errors

AlorApiError::Ws when the connection or the authorization fails; the errors of AlorHttpClient::get_access_token when there is no token.

Source

pub async fn authorize(&self) -> Result<(), AlorApiError>

Authorizes the connection with a fresh access token.

§Errors

AlorApiError::Ws when the broker refuses (code 401) or does not answer in time.

Source

pub async fn command( &self, opcode: &str, fields: Value, ) -> Result<CwsReply, AlorApiError>

Sends a command and waits for its answer. fields is the object of the order (side, quantity, price, instrument, user, …); the session adds opcode and a new guid.

A refusal of the broker (code 400) is returned as a reply, not as an error: the caller reads CwsReply::code and CwsReply::message.

§Errors

AlorApiError::Ws when the connection breaks or no answer comes in time. Both are an unknown outcome for the command.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more