A few more docs

n0-computer · Dec 12, 2024 · 7399e75 · 7399e75
1 parent 9df63b6
commit 7399e75
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/iroh/src/magicsock/relay_actor.rs b/iroh/src/magicsock/relay_actor.rs
@@ -797,7 +797,10 @@ struct ActiveRelayHandle {
 
 /// A packet to send over the relay.
 ///
-/// This is nothing but a newtype, it should be constructed using [`PacketizeIter`].
+/// This is nothing but a newtype, it should be constructed using [`PacketizeIter`].  This
+/// is a packet of one or more datagrams, each prefixed with a u16-be length.  This is what
+/// the `Frame::SendPacket` of the `DerpCodec` transports and is produced by
+/// [`PacketizeIter`] and transformed back into datagrams using [`PacketSplitIter`].
 #[derive(Debug, PartialEq, Eq)]
 struct RelaySendPacket {
     node_id: NodeId,