Struct UdpClient 

pub struct UdpClient { /* private fields */ }

UDP client for sending/receiving OpenIGTLink messages

Provides connectionless communication with low overhead. Suitable for high-frequency updates where occasional packet loss is acceptable.

Performance Characteristics

• Latency: Lower than TCP (no connection setup, no retransmission)
• Throughput: Limited by network MTU (~1500 bytes typical Ethernet)
• Reliability: None (packets may be lost, duplicated, or reordered)

Examples

use openigtlink_rust::io::UdpClient;
use openigtlink_rust::protocol::types::TransformMessage;
use openigtlink_rust::protocol::message::IgtlMessage;

let client = UdpClient::bind("0.0.0.0:0")?;
let transform = TransformMessage::identity();
let msg = IgtlMessage::new(transform, "Tool")?;
client.send_to(&msg, "192.168.1.100:18944")?;

Implementations

impl UdpClient

pub fn bind(local_addr: &str) -> Result<Self>

Bind to a local address

Arguments

• local_addr - Local address to bind (use “0.0.0.0:0” for any available port)

Errors

• IgtlError::Io - Failed to bind socket (address in use, permission denied, etc.)

Examples

use openigtlink_rust::io::UdpClient;

// Bind to any available port
let client = UdpClient::bind("0.0.0.0:0")?;

// Bind to specific port
let client = UdpClient::bind("0.0.0.0:18945")?;

pub fn send_to<T: Message>( &self, msg: &IgtlMessage<T>, target: &str, ) -> Result<()>

Send a message to a remote address

Arguments

• msg - Message to send
• target - Target address (e.g., “127.0.0.1:18944”)

Errors

• IgtlError::Io - Network transmission failed
• IgtlError::BodyTooLarge - Message exceeds UDP MTU (65507 bytes)

Examples

use openigtlink_rust::io::UdpClient;
use openigtlink_rust::protocol::types::TransformMessage;
use openigtlink_rust::protocol::message::IgtlMessage;

let client = UdpClient::bind("0.0.0.0:0")?;
let transform = TransformMessage::identity();
let msg = IgtlMessage::new(transform, "Device")?;
client.send_to(&msg, "127.0.0.1:18944")?;

pub fn receive_from<T: Message>(&self) -> Result<(IgtlMessage<T>, SocketAddr)>

Receive a message (blocking)

Blocks until a datagram is received. Returns the message and sender address.

Returns

Tuple of (message, sender_address)

Errors

• IgtlError::Io - Network read failed or timeout
• IgtlError::InvalidHeader - Malformed header
• IgtlError::CrcMismatch - Data corruption detected

Examples

use openigtlink_rust::io::UdpClient;
use openigtlink_rust::protocol::types::TransformMessage;

let client = UdpClient::bind("0.0.0.0:18944")?;
let (msg, sender) = client.receive_from::<TransformMessage>()?;
println!("Received from {}", sender);

pub fn set_read_timeout(&self, timeout: Option<Duration>) -> Result<()>

Set read timeout

Arguments

• timeout - Timeout duration (None for blocking forever)

Errors

• IgtlError::Io - Failed to set socket option

Examples

use openigtlink_rust::io::UdpClient;
use std::time::Duration;

let client = UdpClient::bind("0.0.0.0:0")?;
client.set_read_timeout(Some(Duration::from_secs(5)))?;

pub fn set_write_timeout(&self, timeout: Option<Duration>) -> Result<()>

Set write timeout

Arguments

• timeout - Timeout duration (None for blocking forever)

Errors

• IgtlError::Io - Failed to set socket option

pub fn local_addr(&self) -> Result<SocketAddr>

Get local socket address

Errors

• IgtlError::Io - Failed to get socket address