share/man/man9f/flushband.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 FLUSHBAND 9F "Jan 16, 2006"
   8 .SH NAME
   9 flushband \- flush messages for a specified priority band
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/stream.h>
  14
  15
  16
  17 \fBvoid\fR \fBflushband\fR(\fBqueue_t\fR \fI*q\fR, \fBunsigned char\fR \fIpri\fR, \fBint\fR \fIflag\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\fIpri\fR\fR
  38 .ad
  39 .RS 8n
  40 Priority of messages to be flushed.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fIflag\fR\fR
  47 .ad
  48 .RS 8n
  49 Valid \fIflag\fR values are:
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBFLUSHDATA\fR\fR
  56 .ad
  57 .RS 13n
  58 Flush only data messages (types \fBM_DATA,\fR \fBM_DELAY,\fR \fBM_PROTO,\fR and
  59 \fBM_PCPROTO\fR \fB\fR).
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fBFLUSHALL\fR\fR
  66 .ad
  67 .RS 13n
  68 Flush all messages.
  69 .RE
  70
  71 .SH DESCRIPTION
  72 .sp
  73 .LP
  74 The \fBflushband()\fR function flushes messages associated with the priority
  75 band specified by \fIpri\fR. If \fIpri\fR is \fB0\fR, only normal and high
  76 priority messages are flushed. Otherwise, messages are flushed from the band
  77 \fIpri\fR according to the value of \fIflag\fR.
  78 .SH CONTEXT
  79 .sp
  80 .LP
  81 The \fBflushband()\fR function can be called from user, interrupt, or kernel
  82 context.
  83 .SH SEE ALSO
  84 .sp
  85 .LP
  86 \fBflushq\fR(9F)
  87 .sp
  88 .LP
  89 \fIWriting Device Drivers\fR \fISTREAMS Programming Guide\fR