Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
Copyright 1989 AT&T
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.
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.
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]
#include <sys/stream.h> void flushq(queue_t *q, int flag);
Architecture independent level 1 (DDI/DKI).
q
Pointer to the queue to be flushed.
flag
Valid flag values are:
FLUSHDATA
Flush only data messages (types M_DATA M_DELAY M_PROTO and M_PCPROTO).
FLUSHALL
Flush all messages.
The flushq() function frees messages and their associated data structures by calling freemsg(9F). If the queue's count falls below the low water mark and the queue was blocking an upstream service procedure, the nearest upstream service procedure is enabled.
The flushq() function can be called from user, interrupt, or kernel context.
Example 1 Using flushq()
This example depicts the canonical flushing code for STREAMS modules. The module has a write service procedure and potentially has messages on the queue. If it receives an M_FLUSH message, and if the FLUSHR bit is on in the first byte of the message (line 10), then the read queue is flushed (line 11). If the FLUSHW bit is on (line 12), then the write queue is flushed (line 13). Then the message is passed along to the next entity in the stream (line 14). See the example for qreply(9F) for the canonical flushing code for drivers.
1 /*
2 * Module write-side put procedure.
3 */
4 xxxwput(q, mp)
5 queue_t *q;
6 mblk_t *mp;
7 {
8 switch(mp->b_datap->db_type) {
9 case M_FLUSH:
10 if (*mp->b_rptr & FLUSHR)
11 flushq(RD(q), FLUSHALL);
12 if (*mp->b_rptr & FLUSHW)
13 flushq(q, FLUSHALL);
14 putnext(q, mp);
15 break;
. . .
16 }
17 }
flushband(9F), freemsg(9F), putq(9F), qreply(9F)
Writing Device Drivers STREAMS Programming Guide