1stropts.h(0P) POSIX Programmer's Manual stropts.h(0P)
2
6 This manual page is part of the POSIX Programmer's Manual. The Linux
7 implementation of this interface may differ (consult the corresponding
8 Linux manual page for details of Linux behavior), or the interface may
9 not be implemented on Linux.
10
13 stropts.h — STREAMS interface (STREAMS)
14
16 #include <stropts.h>
17
19 The <stropts.h> header shall define the bandinfo structure, which shall
20 include at least the following members:
21 int bi_flag Flushing type.
23 unsigned char bi_pri Priority band.
24 The <stropts.h> header shall define the strpeek structure, which shall
26 include at least the following members:
27 struct strbuf ctlbuf The control portion of the message.
29 struct strbuf databuf The data portion of the message.
30 t_uscalar_t flags RS_HIPRI or 0.
31 The <stropts.h> header shall define the strbuf structure, which shall
33 include at least the following members:
34 char *buf Pointer to buffer.
36 int len Length of data.
37 int maxlen Maximum buffer length.
38 The <stropts.h> header shall define the strfdinsert structure, which
40 shall include at least the following members:
41 struct strbuf ctlbuf The control portion of the message.
43 struct strbuf databuf The data portion of the message.
44 int fildes File descriptor of the other STREAM.
45 t_uscalar_t flags RS_HIPRI or 0.
46 int offset Relative location of the stored value.
47 The <stropts.h> header shall define the strioctl structure, which shall
49 include at least the following members:
50 int ic_cmd ioctl() command.
52 char *ic_dp Pointer to buffer.
53 int ic_len Length of data.
54 int ic_timout Timeout for response.
55 The <stropts.h> header shall define the strrecvfd structure, which
57 shall include at least the following members:
58 int fd Received file descriptor.
60 gid_t gid GID of sender.
61 uid_t uid UID of sender.
62 The <stropts.h> header shall define the uid_t and gid_t types through
64 typedef, as described in <sys/types.h>.
65 The <stropts.h> header shall define the t_scalar_t and t_uscalar_t
67 types, respectively, as signed and unsigned opaque types of equal
68 length of at least 32 bits.
69 The <stropts.h> header shall define the str_list structure, which shall
71 include at least the following members:
72 struct str_mlist *sl_modlist STREAMS module names.
74 int sl_nmods Number of STREAMS module names.
75 The <stropts.h> header shall define the str_mlist structure, which
77 shall include at least the following member:
78 char l_name[FMNAMESZ+1] A STREAMS module name.
80 The <stropts.h> header shall define at least the following symbolic
82 constants for use as the request argument to ioctl():
83 I_ATMARK Is the top message ``marked''?
85 I_CANPUT Is a band writable?
87 I_CKBAND See if any messages exist in a band.
89 I_FDINSERT Send implementation-defined information about another
91 STREAM.
92 I_FIND Look for a STREAMS module.
94 I_FLUSH Flush a STREAM.
96 I_FLUSHBAND Flush one band of a STREAM.
98 I_GETBAND Get the band of the top message on a STREAM.
100 I_GETCLTIME Get close time delay.
102 I_GETSIG Retrieve current notification signals.
104 I_GRDOPT Get the read mode.
106 I_GWROPT Get the write mode.
108 I_LINK Connect two STREAMs.
110 I_LIST Get all the module names on a STREAM.
112 I_LOOK Get the top module name.
114 I_NREAD Size the top message.
116 I_PEEK Peek at the top message on a STREAM.
118 I_PLINK Persistently connect two STREAMs.
120 I_POP Pop a STREAMS module.
122 I_PUNLINK Dismantle a persistent STREAMS link.
124 I_PUSH Push a STREAMS module.
126 I_RECVFD Get a file descriptor sent via I_SENDFD.
128 I_SENDFD Pass a file descriptor through a STREAMS pipe.
130 I_SETCLTIME Set close time delay.
132 I_SETSIG Ask for notification signals.
134 I_SRDOPT Set the read mode.
136 I_STR Send a STREAMS ioctl().
138 I_SWROPT Set the write mode.
140 I_UNLINK Disconnect two STREAMs.
142 The <stropts.h> header shall define at least the following symbolic
144 constant for use with I_LOOK:
145 FMNAMESZ The minimum size in bytes of the buffer referred to by the
147 arg argument.
148 The <stropts.h> header shall define at least the following symbolic
150 constants for use with I_FLUSH:
151 FLUSHR Flush read queues.
153 FLUSHRW Flush read and write queues.
155 FLUSHW Flush write queues.
157 The <stropts.h> header shall define at least the following symbolic
159 constants for use with I_SETSIG:
160 S_BANDURG When used in conjunction with S_RDBAND, SIGURG is generated
162 instead of SIGPOLL when a priority message reaches the
163 front of the STREAM head read queue.
164 S_ERROR Notification of an error condition reaches the STREAM head.
166 S_HANGUP Notification of a hangup reaches the STREAM head.
168 S_HIPRI A high-priority message is present on a STREAM head read
170 queue.
171 S_INPUT A message, other than a high-priority message, has arrived
173 at the head of a STREAM head read queue.
174 S_MSG A STREAMS signal message that contains the SIGPOLL signal
176 reaches the front of the STREAM head read queue.
177 S_OUTPUT The write queue for normal data (priority band 0) just
179 below the STREAM head is no longer full. This notifies the
180 process that there is room on the queue for sending (or
181 writing) normal data downstream.
182 S_RDBAND A message with a non-zero priority band has arrived at the
184 head of a STREAM head read queue.
185 S_RDNORM A normal (priority band set to 0) message has arrived at
187 the head of a STREAM head read queue.
188 S_WRBAND The write queue for a non-zero priority band just below the
190 STREAM head is no longer full.
191 S_WRNORM Equivalent to S_OUTPUT.
193 The <stropts.h> header shall define at least the following symbolic
195 constant for use with I_PEEK:
196 RS_HIPRI Only look for high-priority messages.
198 The <stropts.h> header shall define at least the following symbolic
200 constants for use with I_SRDOPT:
201 RMSGD Message-discard mode.
203 RMSGN Message-non-discard mode.
205 RNORM Byte-STREAM mode, the default.
207 RPROTDAT Deliver the control part of a message as data when a
209 process issues a read().
210 RPROTDIS Discard the control part of a message, delivering any data
212 part, when a process issues a read().
213 RPROTNORM Fail read() with [EBADMSG] if a message containing a con‐
215 trol part is at the front of the STREAM head read queue.
216 The <stropts.h> header shall define at least the following symbolic
218 constant for use with I_SWOPT:
219 SNDZERO Send a zero-length message downstream when a write() of 0
221 bytes occurs.
222 The <stropts.h> header shall define at least the following symbolic
224 constants for use with I_ATMARK:
225 ANYMARK Check if the message is marked.
227 LASTMARK Check if the message is the last one marked on the queue.
229 The <stropts.h> header shall define at least the following symbolic
231 constant for use with I_UNLINK:
232 MUXID_ALL Unlink all STREAMs linked to the STREAM associated with
234 fildes.
235 The <stropts.h> header shall define the following symbolic constants
237 for getmsg(), getpmsg(), putmsg(), and putpmsg():
238 MORECTL More control information is left in message.
240 MOREDATA More data is left in message.
242 MSG_ANY Receive any message.
244 MSG_BAND Receive message from specified band.
246 MSG_HIPRI Send/receive high-priority message.
248 The <stropts.h> header may make visible all of the symbols from
250 <unistd.h>.
251 The following shall be declared as functions and may also be defined as
253 macros. Function prototypes shall be provided.
254 int fattach(int, const char *);
256 int fdetach(const char *);
257 int getmsg(int, struct strbuf *restrict, struct strbuf *restrict,
258 int *restrict);
259 int getpmsg(int, struct strbuf *restrict, struct strbuf *restrict,
260 int *restrict, int *restrict);
261 int ioctl(int, int, ...);
262 int isastream(int);
263 int putmsg(int, const struct strbuf *, const struct strbuf *, int);
264 int putpmsg(int, const struct strbuf *, const struct strbuf *, int,
265 int);
266 The following sections are informative.
268
270 None.
271
273 None.
274
276 None.
277
279 <sys_types.h>, <unistd.h>
280 The System Interfaces volume of POSIX.1‐2008, close(), fattach(),
282 fcntl(), fdetach(), getmsg(), ioctl(), isastream(), open(), pipe(),
283 read(), poll(), putmsg(), signal(), write()
284
286 Portions of this text are reprinted and reproduced in electronic form
287 from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
288 -- Portable Operating System Interface (POSIX), The Open Group Base
289 Specifications Issue 7, Copyright (C) 2013 by the Institute of Electri‐
290 cal and Electronics Engineers, Inc and The Open Group. (This is
291 POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
292 event of any discrepancy between this version and the original IEEE and
293 The Open Group Standard, the original IEEE and The Open Group Standard
294 is the referee document. The original Standard can be obtained online
295 at http://www.unix.org/online.html .
296 Any typographical or formatting errors that appear in this page are
298 most likely to have been introduced during the conversion of the source
299 files to man page format. To report such errors, see https://www.ker‐
300 nel.org/doc/man-pages/reporting_bugs.html .
301IEEE/The Open Group 2013 stropts.h(0P)