Expand description
TWS API Client.
The Client establishes the connection to TWS or the Gateway. It manages the routing of messages between TWS and the application. Client implementation with sync/async support.
§Canonical paths
Two canonical spellings for the Client type, depending on which client
you want and which features are enabled:
- Async client —
ibapi::Client. The crate-rootClientre-export resolves to the async client whenever theasyncfeature is on (which is the default). - Blocking (sync) client —
ibapi::client::blocking::Client. The labelledblockingsubmodule is the canonical sync-explicit path. Use it whenever bothsyncandasyncfeatures are enabled, since the rootibapi::Clientresolves to async in that configuration. When onlysyncis enabled,ibapi::Clientalso resolves to the blocking client.
The client::sync and client::r#async submodules where the impls live
are #[doc(hidden)]: still reachable as paths for crate-internal use, but
intentionally absent from the docs.rs navigation. Prefer the root Client
/ client::blocking::Client spellings in user code, examples, and docs.
Raw-identifier syntax (client::r#async::Client) is the giveaway that the
spelling is non-canonical.
Modules§
- blocking
- Blocking client bindings for synchronous workflows.
Structs§
- Client
- Asynchronous TWS API Client
- Client
Builder - Builder for an async
Client. Acquire viaClient::builder.