From fd048a1c8a416a81c90fa5c3b0ef5c9530569a88 Mon Sep 17 00:00:00 2001 From: Brian Somers Date: Fri, 24 Aug 2001 14:52:05 +0000 Subject: [PATCH] Explain what the return value from NgRecvMsg() and NgRecvData() means, specifically that 0 means the socket has been closed. --- lib/libnetgraph/netgraph.3 | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/lib/libnetgraph/netgraph.3 b/lib/libnetgraph/netgraph.3 index feff469bde3..bf2de910426 100644 --- a/lib/libnetgraph/netgraph.3 +++ b/lib/libnetgraph/netgraph.3 @@ -170,6 +170,9 @@ is non-NULL, it must point to a buffer of at least bytes, which will be filled in (and NUL terminated) with the path to the node from which the message was received. .Pp +The length of the control message is returned. +A return value of zero indicates that the socket was closed. +.Pp .Fn NgRecvAsciiMsg works exactly like .Fn NgRecvMsg , @@ -206,6 +209,9 @@ is non-NULL, it must point to a buffer of at least bytes, which will be filled in (and NUL terminated) with the name of the hook on which the data was received. .Pp +The length of the packet is returned. +A return value of zero indicates that the socket was closed. +.Pp .Fn NgSetDebug and .Fn NgSetErrLog