chiark / gitweb /
Makefile: Use check_PROGRAMS target.
[mLib] / man / pkbuf.3
index 4bcc9d371e9b65409124bf213ca075148d3d6fdb..80eed4b549ae39d8026c23cf6ffc07469aa3ac51 100644 (file)
@@ -28,7 +28,7 @@ implement a
 .IR "packet buffer" .
 Given unpredictably-sized chunks of data, the packet buffer extracts
 completed packets of data, with sizes ascertained by a handler
-function. 
+function.
 .PP
 The state of a packet buffer is stored in an object of type
 .BR pkbuf .
@@ -88,11 +88,11 @@ The complex interface is the pair of functions
 and
 .IR pkbuf_flush .
 .PP
-The 
+The
 .B pkbuf_free
 function returns the address and size of a free portion of the packet
 buffer's memory into which data may be written.  The function is passed
-the address 
+the address
 .I pk
 of the packet buffer.  Its result is the size of the free area, and it
 writes the base address of this free space to the location pointed to by
@@ -197,12 +197,12 @@ also be signalled to the higher-level object so that it can detach
 itself from its data source.
 .PP
 Rather than invent some complex interface for this, the packet buffer
-exports one of its structure members,
-.BR flags .
+exports one of its structure members, a flags words called
+.BR f .
 A higher-level object wishing to disable the packet buffer simply clears
 the bit
 .B PKBUF_ENABLE
-in the flags word.
+in this flags word.
 .PP
 Disabling a buffer causes an immediate return from
 .BR pkbuf_flush .