1stropts.h(3HEAD) Headers stropts.h(3HEAD)
2
6 stropts.h, stropts - STREAMS interface (STREAMS)
7
9 #include <stropts.h>
10
13 The <stropts.h> header defines the bandinfo structure, which includes
14 the following members:
15 unsigned char bi_pri /* priority band */
17 int bi_flag /* flushing type */
18 The <stropts.h> header defines the strpeek structure that includes the
22 following members:
23 struct strbuf ctlbuf /* control portion of the message */
25 struct strbuf databuf /* data portion of the message */
26 t_uscalar_t flags /* RS_HIPRI or 0 */
27 The <stropts.h> header defines the strbuf structure that includes the
31 following members:
32 int maxlen /* maximum buffer length */
34 int len /* length of data */
35 char *buf /* pointer to buffer */
36 The <stropts.h> header defines the strfdinsert structure that includes
40 the following members:
41 struct strbuf ctlbuf /* control portion of the message */
43 struct strbuf databuf /* data portion of the message */
44 t_uscalar_t flags /* RS_HIPRI or 0 */
45 int fildes /* file descriptor of the other stream */
46 int offset /* relative location of the stored value */
47 The <stropts.h> header defines the strioctl structure that includes the
51 following members:
52 int ic_cmd /* ioctl() command */
54 int ic_timout /* timeout for response */
55 int ic_len /* length of data */
56 char *ic_dp /* pointer to buffer */
57 The <stropts.h> header defines the strrecvfd structure that includes
61 the following members:
62 int fda /* received file descriptor */
64 uid_t uid /* UID of sender */
65 gid_t gid /* GID of sender */
66 The uid_t and gid_t types are defined through typedef as described in
70 <sys/types.h>. See types.h(3HEAD).
71 The <stropts.h> header defines the t_scalar_t and t_uscalar_t types,
74 respectively, as signed and unsigned opaque types of equal length of at
75 least 32 bits.
76 The <stropts.h> header defines the str_list structure that includes the
79 following members:
80 int sl_nmods /* number of STREAMS module names */
82 struct str_mlist *sl_modlist /* STREAMS module names */
83 The <stropts.h> header defines the str_mlist structure that includes
87 the following member:
88 char l_name[FMNAMESZ+1] a STREAMS module name
90 The following macros are defined for use as the request argument to
94 ioctl():
95 I_PUSH Push a STREAMS module.
97 I_POP Pop a STREAMS module.
100 I_LOOK Get the top module name.
103 I_FLUSH Flush a stream.
106 I_FLUSHBAND Flush one band of a stream.
109 I_SETSIG Ask for notification signals.
112 I_GETSIG Retrieve current notification signals.
115 I_FIND Look for a STREAMS module.
118 I_PEEK Peek at the top message on a stream.
121 I_SRDOPT Set the read mode.
124 I_GRDOPT Get the read mode.
127 I_NREAD Size the top message.
130 I_FDINSERT Send implementation-defined information about another
133 stream.
134 I_STR Send a STREAMS ioctl().
137 I_SWROPT Set the write mode.
140 I_GWROPT Get the write mode.
143 I_SENDFD Pass a file descriptor through a STREAMS pipe.
146 I_RECVFD Get a file descriptor sent via I_SENDFD.
149 I_LIST Get all the module names on a stream.
152 I_ATMARK Is the top message ``marked''?
155 I_CKBAND See if any messages exist in a band.
158 I_GETBAND Get the band of the top message on a stream.
161 I_CANPUT Is a band writable?
164 I_SETCLTIME Set close time delay.
167 I_GETCLTIME Get close time delay.
170 I_LINK Connect two streams.
173 I_UNLINK Disconnect two streams.
176 I_PLINK Persistently connect two streams.
179 I_PUNLINK Dismantle a persistent STREAMS link.
182 The following macro is defined for use with I_LOOK:
186 FMNAMESZ minimum size in bytes of the buffer referred to by the arg
188 argument
189 The following macros are defined for use with I_FLUSH:
193 FLUSHR flush read queues
195 FLUSHW flush write queues
198 FLUSHRW flush read and write queues
201 The following macros are defined for use with I_SETSIG:
205 S_RDNORM A normal (priority band set to 0) message has arrived at
207 the head of a stream head read queue.
208 S_RDBAND A message with a non-zero priority band has arrived at the
211 head of a stream head read queue.
212 S_INPUT A message, other than a high-priority message, has arrived
215 at the head of a stream head read queue.
216 S_HIPRI A high-priority message is present on a stream head read
219 queue.
220 S_OUTPUT The write queue for normal data (priority band 0) just
223 below the stream head is no longer full. This notifies the
224 process that there is room on the queue for sending (or
225 writing) normal data downstream.
226 S_WRNORM Equivalent to S_OUTPUT.
229 S_WRBAND The write queue for a non-zero priority band just below
232 the stream head is no longer full.
233 S_MSG A STREAMS signal message that contains the SIGPOLL signal
236 reaches the front of the stream head read queue.
237 S_ERROR Notification of an error condition reaches the stream
240 head.
241 S_HANGUP Notification of a hangup reaches the stream head.
244 S_BANDURG When used in conjunction with S_RDBAND, SIGURG is gener‐
247 ated instead of SIGPOLL when a priority message reaches
248 the front of the stream head read queue.
249 The following macro is defined for use with I_PEEK:
253 RS_HIPRI Only look for high-priority messages.
255 The following macros are defined for use with I_SRDOPT:
259 RNORM Byte-stream mode, the default.
261 RMSGD Message-discard mode.
264 RMSGN Message-non-discard mode.
267 RPROTNORM Fail read() with [EBADMSG] if a message containing a con‐
270 trol part is at the front of the stream head read queue.
271 RPROTDAT Deliver the control part of a message as data when a
274 process issues a read()
275 RPROTDIS Discard the control part of a message, delivering any data
278 part, when a process issues a read()
279 The following macro is defined for use with I_SWOPT:
283 SNDZERO Send a zero-length message downstream when a write() of 0
285 bytes occurs.
286 The following macros are defined for use with I_ATMARK:
290 ANYMARK Check if the message is marked.
292 LASTMARK Check if the message is the last one marked on the queue.
295 The following macro is defined for use with I_UNLINK:
299 MUXID_ALL Unlink all stream linked to the stream associated with
301 fildes.
302 The following macros are defined for getmsg(), getpmsg(), putmsg(), and
306 putpmsg():
307 MSG_ANY Receive any message.
309 MSG_BAND Receive message from specified band.
312 MSG_HIPRI Send/receive high-priority message.
315 MORECTL More control information is left in message.
318 MOREDATA More data is left in message.
321 The <stropts.h> header can make visible all of the symbols from
325 <unistd.h>.
326
328 See attributes(5) for descriptions of the following attributes:
329 ┌─────────────────────────────┬─────────────────────────────┐
334 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
335 ├─────────────────────────────┼─────────────────────────────┤
336 │Interface Stability │Standard │
337 └─────────────────────────────┴─────────────────────────────┘
338
340 close(2), fcntl(2), getmsg(2), ioctl(2), open(2), pipe(2), poll(2),
341 putmsg(2), read(2), write(2), signal(3C), types.h(3HEAD),
342 unistd.h(3HEAD), attributes(5), standards(5)
343SunOS 5.11 10 Sep 2004 stropts.h(3HEAD)