Struct UserDataConfig 

pub struct UserDataConfig {
    pub tbank: TbankConfig,
    pub source: Arc<str>,
    pub order_state_buffer: usize,
    pub ping_interval: Duration,
    pub price_grid: PriceGrid,
}

User data connector config. One connector = one account: tbank.account_id. With None the connector uses the token’s only open account and refuses to start when there are several.

Several accounts of one token need several connectors, each with its own config that differs in tbank.account_id and in source. Share one rate limiter between them.

Examples

use brokapi_tbank::UserDataConfig;
use brokapi_tbank_protocol::TbankConfig;

let cfg = UserDataConfig::new(TbankConfig::sandbox("t.my-token").with_account("acc-main"), "tbank-ud-main");
assert_eq!(cfg.tbank.account_id.as_deref(), Some("acc-main"));
assert_eq!(cfg.order_state_buffer, 1024);

Fields

tbank: TbankConfig

Endpoint, token, account and timeouts of the API. Set account_id with [TbankConfig::with_account] when the token sees more than one account.

source: Arc<str>

Envelope source label, e.g. "tbank-ud-main". Give every account its own.

order_state_buffer: usize

Lossless buffer capacity for the order state and executions subscriptions.

Own order states and trades are never dropped. If the consumer is so slow that the buffer fills up, an overflow event is sent and the trading gate closes until the next successful reconcile. Default 1024.

ping_interval: Duration

Server ping period on the user data streams. A value outside 5 s to 120 s is brought into that range, both for the request and for the silence limit. A stream silent for three periods is treated as dead and reconnected. Default 30 s.

price_grid: PriceGrid

Price steps the connector checks order prices against (default: empty, nothing is checked). Fill it with [PriceGrid::learn] from the trading parameters of the instruments you trade. A price off the step is then refused with Rejected (price_off_step) before anything is sent.

Implementations

impl UserDataConfig

pub fn new(tbank: TbankConfig, source: impl Into<Arc<str>>) -> UserDataConfig

A config with the default buffer (1024 events) and ping period (30 s).

source labels every Envelope of this connector. Give each account its own label.

Examples

use brokapi_tbank::UserDataConfig;
use brokapi_tbank_protocol::TbankConfig;

let cfg = UserDataConfig::new(TbankConfig::sandbox("t.my-token"), "tbank-ud");
assert_eq!(&*cfg.source, "tbank-ud");

Trait Implementations

impl Clone for UserDataConfig

fn clone(&self) -> UserDataConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UserDataConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.