share/man/man9f/strqset.9f

   1 '\" te
   2 .\" Copyright (c) 2006, 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 STRQSET 9F "Jan 16, 2006"
   8 .SH NAME
   9 strqset \- change information about a queue or band of the queue
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/stream.h>
  14
  15
  16
  17 \fBint\fR \fBstrqset\fR(\fBqueue_t *\fR\fIq\fR, \fBqfields_t\fR \fIwhat\fR, \fBunsigned char\fR \fIpri\fR, \fBintptr_t\fR \fIval\fR);
  18 .fi
  19
  20 .SH INTERFACE LEVEL
  21 .sp
  22 .LP
  23 Architecture independent level 1 (DDI/DKI).
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIq\fR\fR
  29 .ad
  30 .RS 8n
  31 Pointer to the queue.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIwhat\fR\fR
  38 .ad
  39 .RS 8n
  40 Field of the \fBqueue\fR structure (or the specified priority band) to return
  41 information about. Valid values are one of:
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fBQHIWAT\fR\fR
  46 .ad
  47 .RS 11n
  48 High water mark.
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fBQLOWAT\fR\fR
  55 .ad
  56 .RS 11n
  57 Low water mark.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBQMAXPSZ\fR\fR
  64 .ad
  65 .RS 11n
  66 Largest packet accepted.
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fBQMINPSZ\fR\fR
  73 .ad
  74 .RS 11n
  75 Smallest packet accepted.
  76 .RE
  77
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fIpri\fR\fR
  84 .ad
  85 .RS 8n
  86 Priority band of interest.
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fIval\fR\fR
  93 .ad
  94 .RS 8n
  95 The value for the field to be changed.
  96 .RE
  97
  98 .SH DESCRIPTION
  99 .sp
 100 .LP
 101 The \fBstrqset()\fR function gives drivers and modules a way to change
 102 information about a queue or a particular band of a queue without directly
 103 accessing STREAMS data structures.
 104 .SH RETURN VALUES
 105 .sp
 106 .LP
 107 On success, \fB0\fR is returned. \fBEINVAL\fR is returned if an undefined
 108 attribute is specified.
 109 .SH CONTEXT
 110 .sp
 111 .LP
 112 The \fBstrqset()\fR function can be called from user, interrupt, or kernel
 113 context.
 114 .SH SEE ALSO
 115 .sp
 116 .LP
 117 \fBstrqget\fR(9F), \fBqueue\fR(9S)
 118 .sp
 119 .LP
 120 \fIWriting Device Drivers\fR
 121 .sp
 122 .LP
 123 \fISTREAMS Programming Guide\fR
 124 .SH NOTES
 125 .sp
 126 .LP
 127 When lowering existing values, set \fBQMINPSZ\fR before setting \fBQMAXPSZ\fR;
 128 when raising existing values, set \fBQMAXPSZ\fR before setting \fBQMINPSZ\fR.