Struct ConnectionOptions 

pub struct ConnectionOptions { /* private fields */ }

Callback for handling unsolicited messages during connection setup.

When TWS sends messages like OpenOrder or OrderStatus during the connection handshake, this callback is invoked to allow the application to process them instead of discarding them.

Example

use ibapi::{Client, StartupMessageCallback};
use ibapi::messages::IncomingMessages;
use std::sync::{Arc, Mutex};

#[tokio::main]
async fn main() {
    let orders = Arc::new(Mutex::new(Vec::new()));
    let orders_clone = orders.clone();

    let callback: StartupMessageCallback = Box::new(move |msg| {
        match msg.message_type() {
            IncomingMessages::OpenOrder | IncomingMessages::OrderStatus => {
                orders_clone.lock().unwrap().push(msg);
            }
            _ => {}
        }
    });

    let client = Client::connect_with_callback("127.0.0.1:4002", 100, Some(callback))
        .await
        .expect("connection failed");

    println!("Received {} startup orders", orders.lock().unwrap().len());
}

Options for configuring a connection to TWS or IB Gateway.

Use the builder methods to configure options, then pass to Client::connect_with_options.

Examples

use ibapi::ConnectionOptions;

let options = ConnectionOptions::default()
    .tcp_no_delay(true);

Implementations

impl ConnectionOptions

pub fn tcp_no_delay(self, enabled: bool) -> Self

Enable or disable TCP_NODELAY on the connection socket.

When enabled, disables Nagle’s algorithm for lower latency. Default: false.

pub fn startup_callback( self, callback: impl Fn(ResponseMessage) + Send + Sync + 'static, ) -> Self

Set a callback for unsolicited messages during connection setup.

When TWS sends messages like OpenOrder or OrderStatus during the connection handshake, this callback processes them instead of discarding.

Trait Implementations

impl Clone for ConnectionOptions

fn clone(&self) -> ConnectionOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionOptions

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

Formats the value using the given formatter.

impl Default for ConnectionOptions

fn default() -> ConnectionOptions

Returns the “default value” for a type.

impl From<Option<Box<dyn Fn(ResponseMessage) + Sync + Send>>> for ConnectionOptions

fn from(callback: Option<StartupMessageCallback>) -> Self

Converts to this type from the input type.