share/man/man9f/flushq.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 FLUSHQ 9F "Jan 16, 2006"
   8 .SH NAME
   9 flushq \- remove messages from a queue
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/stream.h>
  14
  15
  16
  17 \fBvoid\fR \fBflushq\fR(\fBqueue_t *\fR\fIq\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 to be flushed.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIflag\fR\fR
  38 .ad
  39 .RS 8n
  40 Valid \fIflag\fR values are:
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fBFLUSHDATA\fR\fR
  47 .ad
  48 .RS 13n
  49 Flush only data messages (types \fBM_DATA\fR \fBM_DELAY\fR \fBM_PROTO\fR and
  50 \fBM_PCPROTO\fR).
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fBFLUSHALL\fR\fR
  57 .ad
  58 .RS 13n
  59 Flush all messages.
  60 .RE
  61
  62 .SH DESCRIPTION
  63 .sp
  64 .LP
  65 The \fBflushq()\fR function frees messages and their associated data structures
  66 by calling \fBfreemsg\fR(9F). If the queue's count falls below the low water
  67 mark and the queue was blocking an upstream service procedure, the nearest
  68 upstream service procedure is enabled.
  69 .SH CONTEXT
  70 .sp
  71 .LP
  72 The \fBflushq()\fR function can be called from user, interrupt, or kernel
  73 context.
  74 .SH EXAMPLES
  75 .LP
  76 \fBExample 1 \fRUsing \fBflushq()\fR
  77 .sp
  78 .LP
  79 This example depicts the canonical flushing code for STREAMS modules. The
  80 module has a write service procedure and potentially has messages on the queue.
  81 If it receives an \fBM_FLUSH\fR message, and if the \fBFLUSHR\fR bit is on in
  82 the first byte of the message (line 10), then the read queue is flushed (line
  83 11). If the \fBFLUSHW\fR bit is on (line 12), then the write queue is flushed
  84 (line 13). Then the message is passed along to the next entity in the stream
  85 (line 14). See the example for \fBqreply\fR(9F) for the canonical flushing code
  86 for drivers.
  87
  88 .sp
  89 .in +2
  90 .nf
  91       1  /*
  92       2   * Module write-side put procedure.
  93       3   */
  94       4  xxxwput(q, mp)
  95       5      queue_t *q;
  96       6      mblk_t *mp;
  97       7  {
  98       8   switch(mp->b_datap->db_type) {
  99       9      case M_FLUSH:
 100      10        if (*mp->b_rptr & FLUSHR)
 101      11             flushq(RD(q), FLUSHALL);
 102      12        if (*mp->b_rptr & FLUSHW)
 103      13             flushq(q, FLUSHALL);
 104      14        putnext(q, mp);
 105      15        break;
 106                ...
 107      16   }
 108      17  }
 109 .fi
 110 .in -2
 111
 112 .SH SEE ALSO
 113 .sp
 114 .LP
 115 \fBflushband\fR(9F), \fBfreemsg\fR(9F), \fBputq\fR(9F), \fBqreply\fR(9F)
 116 .sp
 117 .LP
 118 \fIWriting Device Drivers\fR \fISTREAMS Programming Guide\fR