foxglove 0.24.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

use std::sync::Weak;

use super::Status;
use super::connected_client::ConnectedClient;
use crate::SinkId;
pub use crate::remote_common::ClientId;
use crate::remote_common::fetch_asset::SendAssetResponse;

/// A connected client session with the WebSocket server.
#[derive(Debug, Clone)]
pub struct Client {
    id: ClientId,
    sink_id: SinkId,
    client: Weak<ConnectedClient>,
}

impl Client {
    pub(super) fn new(client: &ConnectedClient) -> Self {
        Self {
            id: client.id(),
            sink_id: client.sink_id(),
            client: client.weak().clone(),
        }
    }

    /// Returns the client ID.
    pub fn id(&self) -> ClientId {
        self.id
    }

    /// Returns the client's sink ID.
    pub fn sink_id(&self) -> Option<SinkId> {
        Some(self.sink_id)
    }

    /// Send a status message to this client. Does nothing if client is disconnected.
    pub fn send_status(&self, status: Status) {
        if let Some(client) = self.client.upgrade() {
            client.send_status(status);
        }
    }
}

impl SendAssetResponse for Client {
    fn send_asset_response(&self, result: Result<&[u8], &str>, request_id: u32) {
        if let Some(client) = self.client.upgrade() {
            match result {
                Ok(asset) => client.send_asset_response(asset, request_id),
                Err(err) => client.send_asset_error(err, request_id),
            }
        }
    }
}