maviola 0.3.0

High-level MAVLink communication library with support for essential micro-services.
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

use std::net::{SocketAddr, ToSocketAddrs};

use crate::core::consts::DEFAULT_UDP_HOST;
use crate::core::io::{ConnectionConf, ConnectionDetails, ConnectionInfo};
use crate::core::utils::net::resolve_socket_addr;

use crate::prelude::*;

/// UDP client configuration.
///
/// Provides connection configuration for a node that communicates with a specified UDP port. Use
/// [`UdpServer`] to create a UDP server node.
///
/// In UDP-client mode the node will bind to a random port on the system. The host can be set by
/// [`UdpClient::with_host`]. By default, the host is equal to [`DEFAULT_UDP_HOST`]. It is also
/// possible to specify exact binding address by [`UdpClient::with_bind_addr`].
///
/// # Usage
///
/// Create a synchronous UDP client node:
///
/// ```rust,no_run
/// # #[cfg(feature = "sync")] {
/// use maviola::prelude::*;
///
/// let addr = "127.0.0.1:14500";
/// let host = "127.0.0.1";
///
/// // Create a UDP client node
/// let node = Node::sync::<V2>()
///         /* define other node parameters */
/// #       .system_id(1)
/// #       .component_id(1)
///         .connection(
///             UdpClient::new(addr)    // Configure UDP client connection
///                 .unwrap()
///                 .with_host(host)        // set bind host (random port will be used for bind addr)
///                 .unwrap()
///         ).build().unwrap();
/// # }
/// ```
///
/// Create an asynchronous UDP client node:
///
/// ```rust,no_run
/// # #[cfg(not(feature = "async"))] fn main() {}
/// # #[cfg(feature = "async")]
/// # #[tokio::main] async fn main() {
/// use maviola::prelude::*;
///
/// let addr = "127.0.0.1:14500";
/// let host = "127.0.0.1";
///
/// // Create a UDP client node
/// let node = Node::asnc::<V2>()
///         /* define other node parameters */
/// #       .system_id(1)
/// #       .component_id(1)
///         .connection(
///             UdpClient::new(addr)    // Configure UDP client connection
///                 .unwrap()
///                 .with_host(host)        // set bind host (random port will be used for bind addr)
///                 .unwrap()
///         ).build().await.unwrap();
/// # }
/// ```
#[derive(Clone, Debug)]
pub struct UdpClient {
    pub(crate) addr: SocketAddr,
    pub(crate) host: String,
    pub(crate) bind_addr: Option<SocketAddr>,
    pub(crate) info: ConnectionInfo,
}

impl UdpClient {
    /// Instantiates a UDP client configuration.
    ///
    /// Accepts as `addr` anything that implements [`ToSocketAddrs`], prefers IPv4 addresses if
    /// available.
    pub fn new(addr: impl ToSocketAddrs) -> Result<Self> {
        let addr = resolve_socket_addr(addr)?;
        let info = ConnectionInfo::new(ConnectionDetails::UdpClient { remote_addr: addr });
        let host = DEFAULT_UDP_HOST.into();
        Ok(Self {
            addr,
            host,
            bind_addr: None,
            info,
        })
    }

    /// Adds host to configuration.
    ///
    /// Discards bind address specified by [`UdpClient::with_bind_addr`].
    pub fn with_host(self, host: impl ToString) -> Result<Self> {
        let host = host.to_string();
        resolve_socket_addr(format!("{host}:80"))?;

        Ok(Self {
            addr: self.addr,
            host: host.to_string(),
            bind_addr: None,
            info: self.info,
        })
    }

    /// Adds a specific binding address to configuration.
    ///
    /// If specified, the binding address will have higher priority over host specified by
    /// [`UdpClient::with_host`].
    pub fn with_bind_addr(self, addr: impl ToSocketAddrs) -> Result<Self> {
        Ok(Self {
            addr: self.addr,
            host: self.host,
            bind_addr: Some(resolve_socket_addr(addr)?),
            info: self.info,
        })
    }
}

impl ConnectionConf for UdpClient {
    fn info(&self) -> &ConnectionInfo {
        &self.info
    }
}