From 8612dcd77b5615b10aa3bda36f59031382d83e86 Mon Sep 17 00:00:00 2001 From: Scott Feldman Date: Thu, 8 Jun 2023 23:59:53 -0700 Subject: [PATCH] netdev: improve documentation Call out netdev as L3/L4 interface for TinyGo, to differentiate between netlink which is stricly L2. --- netdev.go | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/netdev.go b/netdev.go index c3922bc..c503e98 100644 --- a/netdev.go +++ b/netdev.go @@ -1,3 +1,5 @@ +// L3/L4 network/transport layer + package net import ( @@ -28,20 +30,19 @@ func useNetdev(dev netdever) { netdev = dev } -// Netdev is TinyGo's network device driver model. Network drivers implement -// the netdever interface, providing a common network I/O interface to TinyGo's -// "net" package. The interface is modeled after the BSD socket interface. -// net.Conn implementations (TCPConn, UDPConn, and TLSConn) use the netdev -// interface for device I/O access. +// netdever is TinyGo's OSI L3/L4 network/transport layer interface. Network +// drivers implement the netdever interface, providing a common network L3/L4 +// interface to TinyGo's "net" package. net.Conn implementations (TCPConn, +// UDPConn, and TLSConn) use the netdever interface for device I/O access. // // A netdever is passed to the "net" package using net.useNetdev(). // // Just like a net.Conn, multiple goroutines may invoke methods on a netdever // simultaneously. // -// NOTE: The netdever interface is mirrored in drivers/netdev.go. +// NOTE: The netdever interface is mirrored in drivers/netdev/netdev.go. // NOTE: If making changes to this interface, mirror the changes in -// NOTE: drivers/netdev.go, and vice-versa. +// NOTE: drivers/netdev/netdev.go, and vice-versa. type netdever interface {