From ec75f608740b68ccf88b9098dfe7dc1bd762ea50 Mon Sep 17 00:00:00 2001 From: sbruens Date: Thu, 14 Nov 2024 13:26:16 -0500 Subject: [PATCH] Add a comment to `NewPacketConn`. --- transport/shadowsocks/packet_listener.go | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/transport/shadowsocks/packet_listener.go b/transport/shadowsocks/packet_listener.go index 2f067e4f..014bb400 100644 --- a/transport/shadowsocks/packet_listener.go +++ b/transport/shadowsocks/packet_listener.go @@ -64,6 +64,11 @@ type packetConn struct { var _ net.PacketConn = (*packetConn)(nil) +// NewPacketConn wraps a [net.Conn] and returns a [net.PacketConn] that encrypts/decrypts +// packets before writing/reading them to/from the underlying connection using the provided +// encryption key. +// +// Closing the returned [net.PacketConn] will also close the underlying [net.Conn]. func NewPacketConn(conn net.Conn, key *EncryptionKey) net.PacketConn { return &packetConn{Conn: conn, key: key} }