openthread/ot/
udp.rs

1// Copyright 2022 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5use crate::prelude_internal::*;
6use std::ptr::{null_mut, NonNull};
7
8/// Functional equivalent of [`otsys::otUdpSocket`](crate::otsys::otUdpSocket).
9#[repr(transparent)]
10pub struct UdpSocket<'a>(pub otUdpSocket, PhantomData<*mut otUdpSocket>, PhantomData<&'a ()>);
11
12impl_ot_castable!(opaque lifetime UdpSocket<'_>, otUdpSocket, Default::default(), Default::default());
13
14impl std::fmt::Debug for UdpSocket<'_> {
15    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
16        f.debug_struct("otUdpSocket")
17            .field("peer_name", &self.peer_name())
18            .field("sock_name", &self.sock_name())
19            .field("handle", &self.get_handle())
20            .finish()
21    }
22}
23
24impl<'a> UdpSocket<'a> {
25    /// The peer IPv6 socket address.
26    pub fn peer_name(&self) -> SockAddr {
27        self.0.mPeerName.into()
28    }
29
30    /// The local IPv6 socket address.
31    pub fn sock_name(&self) -> SockAddr {
32        self.0.mSockName.into()
33    }
34
35    /// A handle to platform's UDP.
36    pub fn get_handle(&self) -> Option<NonNull<::std::os::raw::c_void>> {
37        NonNull::new(self.0.mHandle)
38    }
39
40    /// Change the UDP handle.
41    pub fn set_handle(&mut self, handle: Option<NonNull<::std::os::raw::c_void>>) {
42        self.0.mHandle = handle.map(NonNull::as_ptr).unwrap_or(null_mut());
43    }
44
45    /// Platform callback for handling received data.
46    pub fn handle_receive(&self, msg: &ot::Message<'a>, info: &ot::message::Info) {
47        if let Some(handler) = self.0.mHandler {
48            unsafe {
49                // SAFETY: The safety of this call is predicated on the underlying
50                //         handler not taking ownership of the ot::Message instance.
51                //         This is guaranteed as a part of the API contract.
52                handler(self.0.mContext, msg.as_ot_ptr(), info.as_ot_ptr());
53            }
54        }
55    }
56}
57
58/// Iterates over the available UDP sockets. See [`Udp::udp_get_sockets`].
59#[derive(Debug, Clone)]
60#[repr(transparent)]
61pub struct UdpSocketIterator<'a>(*mut otUdpSocket, PhantomData<&'a ()>);
62
63impl<'a> Iterator for UdpSocketIterator<'a> {
64    type Item = &'a UdpSocket<'a>;
65
66    fn next(&mut self) -> Option<Self::Item> {
67        let ret = unsafe { UdpSocket::ref_from_ot_ptr(self.0) };
68        if ret.is_some() {
69            self.0 = unsafe { (*self.0).mNext };
70        }
71        ret
72    }
73}
74
75/// Methods from the [OpenThread "UDP" Module](https://openthread.io/reference/group/api-udp).
76pub trait Udp {
77    /// Functional equivalent of [`otsys::otUdpGetSockets`](crate::otsys::otUdpGetSockets).
78    fn udp_get_sockets(&self) -> UdpSocketIterator<'_>;
79}
80
81impl<T: Udp + ot::Boxable> Udp for ot::Box<T> {
82    fn udp_get_sockets(&self) -> UdpSocketIterator<'_> {
83        self.as_ref().udp_get_sockets()
84    }
85}
86
87impl Udp for Instance {
88    fn udp_get_sockets(&self) -> UdpSocketIterator<'_> {
89        UdpSocketIterator(unsafe { otUdpGetSockets(self.as_ot_ptr()) }, PhantomData)
90    }
91}
openthread/ot/udp.rs

openthread/ot/
udp.rs
