1stroptions(9S)            Data Structures for Drivers           stroptions(9S)
2
3
4

NAME

6       stroptions - options structure for M_SETOPTS message
7

SYNOPSIS

9       #include <sys/stream.h>
10       #include <sys/stropts.h>
11       #include <sys/ddi.h>
12       #include <sys/sunddi.h>
13
14

INTERFACE LEVEL

16       Architecture independent level 1 (DDI/DKI)
17

DESCRIPTION

19       The  M_SETOPTS  message  contains a stroptions structure and is used to
20       control options in the stream head.
21

STRUCTURE MEMBERS

23         uint_t           so_flags;      /* options to set */
24         short            so_readopt;    /* read option */
25         ushort_t         so_wroff;      /* write offset */
26         ssize_t          so_minpsz;     /* minimum read packet size */
27         ssize_t          so_maxpsz;     /* maximum read packet size */
28         size_t           so_hiwat;      /* read queue high water mark */
29         size_t           so_lowat;      /* read queue low water mark */
30         unsigned char    so_band;       /* band for water marks */
31         ushort_t         so_erropt;     /* error option */
32
33
34
35       The following are the flags that can be set in the so_flags bit mask in
36       the stroptions structure.  Note that multiple flags can be set.
37
38       SO_READOPT           Set read option.
39
40
41       SO_WROFF             Set write offset.
42
43
44       SO_MINPSZ            Set minimum packet size
45
46
47       SO_MAXPSZ            Set maximum packet size.
48
49
50       SO_HIWAT             Set high water mark.
51
52
53       SO_LOWAT             Set low water mark.
54
55
56       SO_MREADON           Set read notification ON.
57
58
59       SO_MREADOFF          Set read notification OFF.
60
61
62       SO_NDELON            Old TTY semantics for NDELAY reads and writes.
63
64
65       SO_NDELOFFSTREAMS    Semantics for NDELAY reads and writes.
66
67
68       SO_ISTTY             The stream is acting as a terminal.
69
70
71       SO_ISNTTY            The stream is not acting as a terminal.
72
73
74       SO_TOSTOP            Stop on background writes to this stream.
75
76
77       SO_TONSTOP           Do not stop on background writes to this stream.
78
79
80       SO_BAND              Water marks affect band.
81
82
83       SO_ERROPT            Set error option.
84
85
86
87       When  SO_READOPT  is set, the so_readopt field of the stroptions struc‐
88       ture can take one of the following values. See read(2).
89
90       RNORM    Read message normal.
91
92
93       RMSGD    Read message discard.
94
95
96       RMSGN    Read message, no discard.
97
98
99
100       When SO_BAND is set, so_band determines  to  which  band  so_hiwat  and
101       so_lowat apply.
102
103
104       When  SO_ERROPT is set, the so_erropt field of the stroptions structure
105       can take a value that is either none or one of:
106
107       RERRNORM          Persistent read errors; default.
108
109
110       RERRNONPERSIST    Non-persistent read errors.
111
112
113
114       OR'ed with either none or one of:
115
116       WERRNORM          Persistent write errors; default.
117
118
119       WERRNONPERSIST    Non-persistent write errors.
120
121

SEE ALSO

123       read(2), streamio(7I)
124
125
126       STREAMS Programming Guide
127
128
129
130SunOS 5.11                        14 Nov 1996                   stroptions(9S)