foxglove 0.25.0

Foxglove SDK
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

//! Types shared between the WebSocket server and the remote-access gateway.
//!
//! Everything in this module is transport-agnostic: handler traits ([`ParameterHandler`],
//! [`AssetHandler`], [`service::Handler`]) implemented against these types can be registered with
//! either the WebSocket server or the remote-access gateway, and data and identity types
//! ([`Parameter`], [`Status`], [`ConnectionGraph`], [`ClientId`], [`service::Service`], ...) are
//! the same concrete types used by both. The transport-specific [`crate::websocket`] and
//! [`crate::remote_access`] modules re-export the same items for convenience.

use std::sync::atomic::{AtomicU32, Ordering};

#[cfg(any(feature = "websocket", feature = "remote-access"))]
pub(crate) mod any_client;
pub(crate) mod connection_graph;
#[cfg(any(feature = "websocket", feature = "remote-access"))]
pub(crate) mod fetch_asset;
#[cfg(any(feature = "websocket", feature = "remote-access"))]
pub(crate) mod parameters;
pub(crate) mod semaphore;
pub mod service;

#[cfg(any(feature = "websocket", feature = "remote-access"))]
pub use any_client::AnyClient;
pub use connection_graph::ConnectionGraph;
#[cfg(any(feature = "websocket", feature = "remote-access"))]
pub use fetch_asset::{AssetHandler, AssetResponder};
#[cfg(any(feature = "websocket", feature = "remote-access"))]
pub use parameters::{GetParametersResponder, ParameterHandler, SetParametersResponder};

pub use crate::protocol::common::parameter::{
    DecodeError as ParameterDecodeError, Parameter, ParameterType, ParameterValue,
};
pub use crate::protocol::common::server::status::{Level as StatusLevel, Status};

/// Identifies a client connection. Unique for the duration of the server's lifetime.
#[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)]
pub struct ClientId(pub(crate) u32);

impl ClientId {
    pub(crate) fn next() -> Self {
        static NEXT_ID: AtomicU32 = AtomicU32::new(1);
        let id = NEXT_ID.fetch_add(1, Ordering::Relaxed);
        assert_ne!(id, 0, "ClientId overflowed");
        Self(id)
    }
}

impl From<ClientId> for u32 {
    fn from(client: ClientId) -> Self {
        client.0
    }
}

impl std::fmt::Display for ClientId {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.0)
    }
}