knust 0.1.0

Asynchronous KNX/IP library for Rust
Documentation
//! Transport layer for KNX/IP communication.
//!
//! This module provides the low-level networking functionality for KNX/IP
//! communication, including UDP socket management, connection establishment,
//! and data transmission/reception.

pub mod address_probe;
pub mod address_registry;
pub mod backoff;
pub mod connection;
pub mod dedup;
pub mod discovery;
pub mod frame_transport;
pub mod gateway_connection;
pub mod health;
pub mod heartbeat;
pub mod multi;
pub mod queue;
pub mod rate_limit;
pub mod receive_limiter;
pub mod router;
pub mod routing;
#[cfg(feature = "server")]
pub mod server;
pub mod tunnel;

#[cfg(test)]
mod tests;

#[cfg(test)]
mod tunneling_test;

#[cfg(test)]
mod integration_tests;

use crate::protocol::address::IndividualAddress;
use std::net::{IpAddr, SocketAddr};
use std::time::Duration;

pub use address_probe::{auto_select_address, probe_address};
pub use address_registry::AddressRegistry;
pub use backoff::JitteredBackoff;
pub use connection::{Connection, ConnectionState};
pub use discovery::{GatewayCapabilities, GatewayInfo, GatewayScanner, ServiceType};
pub use frame_transport::{FrameTransport, TcpFrameTransport, TransportKind, UdpFrameTransport};
pub use gateway_connection::GatewayConnection;
pub use health::{ConnectionHealth, GatewayConnectionState};
pub use multi::MultiConnection;
pub use queue::{QueueConfig, QueueStats, TelegramQueue};
pub use rate_limit::{RateLimitConfig, RateLimiter};
pub use receive_limiter::{ReceiveLimitConfig, ReceiveRateLimiter, ReceiveResult, ReceiveStats};
pub use router::FrameRouter;
pub use routing::RoutingConnection;
#[cfg(feature = "server")]
pub use server::TunnelServer;
pub use tunnel::{SequenceValidationResult, Tunnel};

/// Configuration for KNX/IP connections
#[derive(Debug, Clone)]
pub struct ConnectionConfig {
    /// Type of connection to establish
    pub connection_type: ConnectionType,

    /// Gateway IP address (required for tunneling)
    pub gateway_ip: Option<IpAddr>,

    /// Gateway port (defaults to 3671 for KNX/IP)
    pub gateway_port: Option<u16>,

    /// Local IP address to bind to
    pub local_ip: Option<IpAddr>,

    /// Individual address for this client
    pub individual_address: IndividualAddress,

    /// Security configuration
    pub security: Option<SecurityConfig>,

    /// Connection timeout in milliseconds
    pub timeout_ms: u64,

    /// Enable automatic reconnection
    pub auto_reconnect: bool,

    /// Reconnection backoff settings
    pub reconnect_backoff: BackoffConfig,

    /// TCP-specific configuration
    pub tcp_config: TcpConfig,
}

impl Default for ConnectionConfig {
    fn default() -> Self {
        Self {
            connection_type: ConnectionType::Tunneling,
            gateway_ip: None,
            gateway_port: Some(3671), // Standard KNX/IP port
            local_ip: None,
            individual_address: IndividualAddress::new(1, 1, 240), // Default client address
            security: None,
            timeout_ms: 5000,
            auto_reconnect: true,
            reconnect_backoff: BackoffConfig::default(),
            tcp_config: TcpConfig::default(),
        }
    }
}

/// Types of KNX/IP connections
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ConnectionType {
    /// Point-to-point tunneling connection (UDP)
    Tunneling,

    /// Point-to-point tunneling connection (TCP)
    TcpTunneling,

    /// Multicast routing connection
    Routing,

    /// Secure tunneling connection
    SecureTunneling,

    /// Secure routing connection
    SecureRouting,
}

/// Security configuration for secure connections.
#[derive(Debug, Clone)]
pub struct SecurityConfig {
    /// Device authentication password (plaintext) — e.g. the FDSK printed on
    /// the device (strip the grouping hyphens/spaces first), or a custom
    /// device authentication password set via ETS. Derived via PBKDF2 the
    /// same way as `user_password` — pass the password as-is, not pre-derived
    /// key bytes.
    pub device_auth_password: String,

    /// User password (plaintext).
    pub user_password: Option<String>,

    /// Keyring file path
    pub keyring_path: Option<String>,

    /// Security session timeout in seconds
    pub session_timeout: u32,
}

/// Backoff configuration for reconnection attempts
#[derive(Debug, Clone)]
pub struct BackoffConfig {
    /// Initial backoff delay in milliseconds
    pub initial_delay_ms: u64,

    /// Maximum backoff delay in milliseconds
    pub max_delay_ms: u64,

    /// Backoff multiplier
    pub multiplier: f64,

    /// Maximum number of retry attempts
    pub max_attempts: u32,
}

impl Default for BackoffConfig {
    fn default() -> Self {
        Self {
            initial_delay_ms: 1000,
            max_delay_ms: 30000,
            multiplier: 2.0,
            max_attempts: 10,
        }
    }
}

/// TCP-specific configuration options
#[derive(Debug, Clone)]
pub struct TcpConfig {
    /// TCP connection timeout in milliseconds
    pub connect_timeout_ms: u64,

    /// TCP read timeout in milliseconds
    pub read_timeout_ms: u64,

    /// TCP write timeout in milliseconds
    pub write_timeout_ms: u64,

    /// Enable TCP keep-alive
    pub keep_alive_enabled: bool,

    /// TCP keep-alive interval in milliseconds
    pub keep_alive_interval_ms: u64,

    /// Enable `TCP_NODELAY` (disable Nagle's algorithm)
    pub tcp_nodelay: bool,
}

impl Default for TcpConfig {
    fn default() -> Self {
        Self {
            connect_timeout_ms: 5000,
            read_timeout_ms: 10000,
            write_timeout_ms: 5000,
            keep_alive_enabled: true,
            keep_alive_interval_ms: 30000,
            tcp_nodelay: true, // Disable Nagle for low-latency KNX communication
        }
    }
}

/// Configuration for a single KNX/IP gateway.
#[derive(Debug, Clone)]
pub struct GatewayConfig {
    /// Gateway socket address (IP:port)
    pub address: SocketAddr,
    /// Human-readable name for logging/identification
    pub name: Option<String>,
    /// Priority (0 = highest, used for failover ordering)
    pub priority: u8,
    /// Connection type for this gateway
    pub connection_type: ConnectionType,
    /// Individual address override (if None, uses `MultiConnectionConfig` default)
    pub individual_address: Option<IndividualAddress>,
}

/// Configuration for multi-gateway connections.
#[derive(Debug, Clone)]
pub struct MultiConnectionConfig {
    /// List of gateways to connect to (ordered by priority)
    pub gateways: Vec<GatewayConfig>,
    /// Backoff configuration for reconnection
    pub backoff: BackoffConfig,
    /// Rate limiting configuration per connection
    pub rate_limit: RateLimitConfig,
    /// Deduplication time window (telegrams within this window are considered duplicates)
    pub deduplication_window: Duration,
    /// Default individual address for all connections
    pub individual_address: IndividualAddress,
    /// Heartbeat configuration
    pub heartbeat: heartbeat::HeartbeatConfig,
}

impl Default for MultiConnectionConfig {
    fn default() -> Self {
        Self {
            gateways: Vec::new(),
            backoff: BackoffConfig::default(),
            rate_limit: RateLimitConfig::default(),
            deduplication_window: Duration::from_secs(2),
            individual_address: IndividualAddress::new(1, 1, 240),
            heartbeat: heartbeat::HeartbeatConfig::default(),
        }
    }
}