simple-someip 0.10.0

A lightweight SOME/IP serialization and communication library
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

//! Shared network-endpoint identity types.
//!
//! [`NetEndpoint`] is the crate's transport-layer identity: the full spec
//! socket plus the transport protocol. AUTOSAR `PRS_SOMEIP` §4.2.1.3
//! identifies a service instance "through the combination of the Service
//! ID combined with the socket (i.e. IP-address, transport protocol, and
//! port number)" — this type is the socket half of that pair. It carries
//! no application-layer discriminator (service id, instance id,
//! eventgroup), so sibling protocol crates can share the same shape.

use core::net::SocketAddr;

/// Transport protocol of a network endpoint.
///
/// `Udp`/`Tcp` correspond to the IANA protocol numbers SOME/IP-SD
/// endpoint options carry on the wire (0x11 / 0x06) — the only two
/// transport protocols the SOME/IP specification defines for endpoint
/// options.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
#[non_exhaustive]
pub enum TransportProtocol {
    /// UDP (IANA 0x11).
    Udp,
    /// TCP (IANA 0x06).
    Tcp,
}

/// A full transport endpoint: socket address plus transport protocol.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub struct NetEndpoint {
    /// IP address and port.
    pub addr: SocketAddr,
    /// Transport protocol on that socket.
    pub protocol: TransportProtocol,
}

impl NetEndpoint {
    #[must_use]
    pub const fn new(addr: SocketAddr, protocol: TransportProtocol) -> Self {
        Self { addr, protocol }
    }

    #[must_use]
    pub const fn udp(addr: SocketAddr) -> Self {
        Self::new(addr, TransportProtocol::Udp)
    }

    #[must_use]
    pub const fn tcp(addr: SocketAddr) -> Self {
        Self::new(addr, TransportProtocol::Tcp)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use core::net::{Ipv4Addr, SocketAddrV4};

    #[test]
    fn constructors_set_protocol() {
        let addr = SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::LOCALHOST, 30490));
        assert_eq!(NetEndpoint::udp(addr).protocol, TransportProtocol::Udp);
        assert_eq!(NetEndpoint::tcp(addr).protocol, TransportProtocol::Tcp);
        assert_eq!(NetEndpoint::udp(addr).addr, addr);
    }

    #[test]
    fn endpoints_differing_only_in_protocol_are_distinct() {
        let addr = SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::LOCALHOST, 30490));
        assert_ne!(NetEndpoint::udp(addr), NetEndpoint::tcp(addr));
    }
}