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

   1 '\" te
   2 .\" Copyright (c) 2000, 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 QBAND 9S "Nov 14, 1996"
   8 .SH NAME
   9 qband \- STREAMS queue flow control information structure
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/stream.h>
  14 .fi
  15
  16 .SH INTERFACE LEVEL
  17 .sp
  18 .LP
  19 Architecture independent level 1 (DDI/DKI)
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The  \fBqband\fR structure contains flow control information for each priority
  24 band in a queue.
  25 .sp
  26 .LP
  27 The \fBqband\fR structure is defined as type \fBqband_t\fR.
  28 .SH STRUCTURE MEMBERS
  29 .sp
  30 .in +2
  31 .nf
  32 struct        qband*qb_next;     /* next band's info */
  33 size_t        qb_count           /* number of bytes in band */
  34 struct msgb   *qb_first;         /* start of band's data */
  35 struct msgb   *qb_last;          /* end of band's data */
  36 size_t        qb_hiwat;          /* band's high water mark */
  37 size_t        qb_lowat;          /* band's low water mark */
  38 uint_t        qb_flag;           /* see below */
  39 .fi
  40 .in -2
  41
  42 .sp
  43 .LP
  44 Valid flags are as follows:
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fBQB_FULL\fR \fR
  49 .ad
  50 .RS 13n
  51 Band is considered full.
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBQB_WANTW\fR \fR
  58 .ad
  59 .RS 13n
  60 Someone wants to write to band.
  61 .RE
  62
  63 .SH SEE ALSO
  64 .sp
  65 .LP
  66 \fBstrqget\fR(9F), \fBstrqset\fR(9F), \fBmsgb\fR(9S), \fBqueue\fR(9S)
  67 .sp
  68 .LP
  69 \fISTREAMS Programming Guide\fR
  70 .SH NOTES
  71 .sp
  72 .LP
  73 All access to this structure should be through \fBstrqget\fR(9F) and
  74 \fBstrqset\fR(9F). It is logically part of the \fBqueue\fR(9S) and its layout
  75 and partitioning with respect to that structure might change in future
  76 releases. If portability is a concern, do not declare or store instances of or
  77 references to this structure.