2 .TH selbuf 3 "23 May 1999" mLib
4 selbuf \- line-buffering input selector
10 .B "#include <mLib/selbuf.h>"
12 .BI "void selbuf_enable(selbuf *" b );
13 .BI "void selbuf_disable(selbuf *" b );
14 .BI "void selbuf_init(selbuf *" b ,
15 .BI " sel_state *" s ,
17 .BI " void (*" func ")(char *" s ", void *" p ),
23 subsystem is a selector which integrates with the
25 system for I/O multiplexing. It reads entire text lines from a file
26 descriptor and passes them to a caller-defined function. It uses the
27 line buffer described in
29 to do its work: you should read about it in order to understand exactly
30 what gets considered to be a line of text and what doesn't, and the
31 exact rules about what your line handling function should and shouldn't
36 selector is stored in an object of type
38 This object must be allocated by the caller, and initialized using the
40 function. This requires a fair few arguments:
48 Pointer to a multiplexor object (type
50 to which this selector should be attached. See
52 for more details about multiplexors, and how this whole system works.
55 The file descriptor of the stream the selector should read from.
60 function. It is passed a pointer to each line read from the file (or
61 null to indicate end-of-file) and an arbitrary pointer (the
68 A pointer argument passed to
70 for each line read from the file. Apart from this, the pointer is not
75 selector is immediately active. Subsequent calls to
77 on the same multiplexor will cause any complete lines read from the file
78 to be passed to your handling function. This function can at any time
81 to stop itself from being called any more. The selector is then
82 disengaged from the I/O multiplexor and won't do anything until
86 may well immediately start emitting complete lines of text which were
87 queued up from the last I/O operation: it doesn't necessarily wait for
96 Mark Wooding, <mdw@nsict.org>