usr/src/man/man9s/stroptions.9s

   1 '\" te
   2 .\" Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" Copyright 1989 AT&T
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH STROPTIONS 9S "Nov 14, 1996"
   8 .SH NAME
   9 stroptions \- options structure for M_SETOPTS message
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/stream.h>
  14 #include <sys/stropts.h>
  15 #include <sys/ddi.h>
  16 #include <sys/sunddi.h>
  17 .fi
  18
  19 .SH INTERFACE LEVEL
  20 .sp
  21 .LP
  22 Architecture independent level 1 (DDI/DKI)
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 The \fBM_SETOPTS\fR message contains a \fBstroptions\fR structure and is used
  27 to control options in the stream head.
  28 .SH STRUCTURE MEMBERS
  29 .sp
  30 .in +2
  31 .nf
  32 uint_t           so_flags;      /* options to set */
  33 short            so_readopt;    /* read option */
  34 ushort_t         so_wroff;      /* write offset */
  35 ssize_t          so_minpsz;     /* minimum read packet size */
  36 ssize_t          so_maxpsz;     /* maximum read packet size */
  37 size_t           so_hiwat;      /* read queue high water mark */
  38 size_t           so_lowat;      /* read queue low water mark */
  39 unsigned char    so_band;       /* band for water marks */
  40 ushort_t         so_erropt;     /* error option */
  41 .fi
  42 .in -2
  43
  44 .sp
  45 .LP
  46 The following are the flags that can be set in the \fBso_flags\fR bit mask in
  47 the \fBstroptions\fR structure.  Note that multiple flags can be set.
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBSO_READOPT\fR\fR
  52 .ad
  53 .RS 21n
  54 Set read option.
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fBSO_WROFF\fR\fR
  61 .ad
  62 .RS 21n
  63 Set write offset.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBSO_MINPSZ\fR\fR
  70 .ad
  71 .RS 21n
  72 Set minimum packet size
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBSO_MAXPSZ\fR\fR
  79 .ad
  80 .RS 21n
  81 Set maximum packet size.
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBSO_HIWAT\fR\fR
  88 .ad
  89 .RS 21n
  90 Set high water mark.
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBSO_LOWAT\fR\fR
  97 .ad
  98 .RS 21n
  99 Set low water mark.
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fBSO_MREADON\fR\fR
 106 .ad
 107 .RS 21n
 108 Set read notification ON.
 109 .RE
 110
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fBSO_MREADOFF\fR\fR
 115 .ad
 116 .RS 21n
 117 Set read notification OFF.
 118 .RE
 119
 120 .sp
 121 .ne 2
 122 .na
 123 \fB\fBSO_NDELON\fR\fR
 124 .ad
 125 .RS 21n
 126 Old TTY semantics for NDELAY reads and writes.
 127 .RE
 128
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fBSO_NDELOFFSTREAMS\fR\fR
 133 .ad
 134 .RS 21n
 135 Semantics for NDELAY reads and writes.
 136 .RE
 137
 138 .sp
 139 .ne 2
 140 .na
 141 \fB\fBSO_ISTTY\fR\fR
 142 .ad
 143 .RS 21n
 144 The stream is acting as a terminal.
 145 .RE
 146
 147 .sp
 148 .ne 2
 149 .na
 150 \fB\fBSO_ISNTTY\fR\fR
 151 .ad
 152 .RS 21n
 153 The stream is not acting as a terminal.
 154 .RE
 155
 156 .sp
 157 .ne 2
 158 .na
 159 \fB\fBSO_TOSTOP\fR\fR
 160 .ad
 161 .RS 21n
 162 Stop on background writes to this stream.
 163 .RE
 164
 165 .sp
 166 .ne 2
 167 .na
 168 \fB\fBSO_TONSTOP\fR\fR
 169 .ad
 170 .RS 21n
 171 Do not stop on background writes to this stream.
 172 .RE
 173
 174 .sp
 175 .ne 2
 176 .na
 177 \fB\fBSO_BAND\fR\fR
 178 .ad
 179 .RS 21n
 180 Water marks affect band.
 181 .RE
 182
 183 .sp
 184 .ne 2
 185 .na
 186 \fB\fBSO_ERROPT\fR\fR
 187 .ad
 188 .RS 21n
 189 Set error option.
 190 .RE
 191
 192 .sp
 193 .LP
 194 When \fBSO_READOPT\fR is set, the \fBso_readopt\fR field of the
 195 \fBstroptions\fR structure can take one of the following values. See
 196 \fBread\fR(2).
 197 .sp
 198 .ne 2
 199 .na
 200 \fB\fBRNORM\fR\fR
 201 .ad
 202 .RS 9n
 203 Read message normal.
 204 .RE
 205
 206 .sp
 207 .ne 2
 208 .na
 209 \fB\fBRMSGD\fR\fR
 210 .ad
 211 .RS 9n
 212 Read message discard.
 213 .RE
 214
 215 .sp
 216 .ne 2
 217 .na
 218 \fB\fBRMSGN\fR\fR
 219 .ad
 220 .RS 9n
 221 Read message, no discard.
 222 .RE
 223
 224 .sp
 225 .LP
 226 When \fBSO_BAND\fR is set, \fBso_band\fR determines to which band
 227 \fBso_hiwat\fR and \fBso_lowat\fR apply.
 228 .sp
 229 .LP
 230 When \fBSO_ERROPT\fR is set, the \fBso_erropt\fR field of the \fBstroptions\fR
 231 structure can take a value that is either none or one of:
 232 .sp
 233 .ne 2
 234 .na
 235 \fB\fBRERRNORM\fR\fR
 236 .ad
 237 .RS 18n
 238 Persistent read errors; default.
 239 .RE
 240
 241 .sp
 242 .ne 2
 243 .na
 244 \fB\fBRERRNONPERSIST\fR\fR
 245 .ad
 246 .RS 18n
 247 Non-persistent read errors.
 248 .RE
 249
 250 .sp
 251 .LP
 252 \fBOR'ed \fRwith either none or one of:
 253 .sp
 254 .ne 2
 255 .na
 256 \fB\fBWERRNORM\fR\fR
 257 .ad
 258 .RS 18n
 259 Persistent write errors; default.
 260 .RE
 261
 262 .sp
 263 .ne 2
 264 .na
 265 \fB\fBWERRNONPERSIST\fR\fR
 266 .ad
 267 .RS 18n
 268 Non-persistent write errors.
 269 .RE
 270
 271 .SH SEE ALSO
 272 .sp
 273 .LP
 274 \fBread\fR(2), \fBstreamio\fR(7I)
 275 .sp
 276 .LP
 277 \fISTREAMS Programming Guide\fR