mbus-ffi 0.13.0

//! Forward-compatible Python `GatewayEventHandler` base class.
//!
//! `GatewayEventHandler` allows Python applications to receive telemetry events
//! such as connection routing, forwarding, and errors from the underlying Rust
//! gateway server.

use pyo3::prelude::*;

/// Subclass to receive gateway lifecycle events.
///
/// All methods are no-ops by default. Override only those you need.
#[pyclass(name = "GatewayEventHandler", subclass)]
pub struct GatewayEventHandler;

#[pymethods]
impl GatewayEventHandler {
    #[new]
    fn new() -> Self {
        Self
    }

    /// Called when the gateway forwards a request to a downstream channel.
    #[allow(unused_variables)]
    fn on_forward(&self, session_id: u8, unit_id: u8, channel_idx: u16) {}

    /// Called when a downstream response has been returned upstream.
    #[allow(unused_variables)]
    fn on_response_returned(&self, session_id: u8, upstream_txn: u16) {}

    /// Called when no route matches the unit ID in an upstream request.
    #[allow(unused_variables)]
    fn on_routing_miss(&self, session_id: u8, unit_id: u8) {}

    /// Called when a downstream did not respond before the timeout.
    #[allow(unused_variables)]
    fn on_downstream_timeout(&self, session_id: u8, internal_txn: u16) {}

    /// Called when the upstream session disconnects.
    #[allow(unused_variables)]
    fn on_upstream_disconnect(&self, session_id: u8) {}
}