ibapi 5.2.0

An unofficial Rust client for the Interactive Brokers TWS API. Async (Tokio) and blocking clients for TWS and IB Gateway.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

//! Latching shutdown signal shared by the blocking bus and its connection.

use std::sync::{Condvar, Mutex, PoisonError};
use std::time::Duration;

use crate::transport::common::lock;

/// Records that shutdown was requested and wakes anyone waiting on it.
///
/// The flag latches: a request made before a wait starts is still observed.
/// `Connection::reconnect` holds one so its backoff wait ends as soon as the
/// bus (or `Client::drop`) asks to shut down, instead of running the whole
/// Fibonacci schedule.
#[derive(Debug, Default)]
pub(crate) struct ShutdownSignal {
    requested: Mutex<bool>,
    changed: Condvar,
}

impl ShutdownSignal {
    pub(crate) fn is_requested(&self) -> bool {
        *lock(&self.requested)
    }

    pub(crate) fn request(&self) {
        *lock(&self.requested) = true;
        self.changed.notify_all();
    }

    /// Block for up to `duration`, returning early once shutdown is requested.
    pub(crate) fn wait_timeout(&self, duration: Duration) {
        let requested = lock(&self.requested);
        let _ = self
            .changed
            .wait_timeout_while(requested, duration, |requested| !*requested)
            .map_err(PoisonError::into_inner);
    }
}

#[cfg(test)]
#[path = "shutdown_tests.rs"]
mod tests;