share/man/man9f/qunbufcall.9f

   1 '\" te
   2 .\"  Copyright 2006 Sun Microsystems.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH QUNBUFCALL 9F "Jan 16, 2006"
   7 .SH NAME
   8 qunbufcall \- cancel a pending qbufcall request
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/stream.h>
  13  #include <sys/ddi.h>
  14
  15
  16 \fBvoid\fR \fBqunbufcall\fR(\fBqueue_t *\fR\fIq\fR, \fBbufcall_id_t\fR \fIid\fR);
  17 .fi
  18
  19 .SH INTERFACE LEVEL
  20 .sp
  21 .LP
  22 Solaris DDI specific (Solaris DDI).
  23 .SH PARAMETERS
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fIq\fR\fR
  28 .ad
  29 .RS 6n
  30 Pointer to \fBSTREAMS\fR queue_t structure.
  31 .RE
  32
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fIid\fR\fR
  37 .ad
  38 .RS 6n
  39 Identifier returned from \fBqbufcall\fR(9F).
  40 .RE
  41
  42 .SH DESCRIPTION
  43 .sp
  44 .LP
  45 The \fBqunbufcall()\fR function cancels a pending \fBqbufcall()\fR request. The
  46 argument \fIid\fR is a non-zero identifier of the request to be cancelled.
  47 \fIid\fR is returned from the \fBqbufcall()\fR function used to issue the
  48 cancel request.
  49 .sp
  50 .LP
  51 The \fBqunbufcall()\fR function is tailored to be used with the enhanced
  52 \fBSTREAMS \fRframework interface which is based on the concept of perimeters.
  53 (See \fBmt-streams\fR(9F).) \fBqunbufcall()\fR returns when the bufcall has
  54 been cancelled or finished executing. The bufcall will be cancelled even if it
  55 is blocked at the perimeters associated with the queue. All outstanding
  56 timeouts and bufcalls must be cancelled before a driver close routine can block
  57 and before the close  routine calls \fBqprocsoff\fR(9F).
  58 .SH CONTEXT
  59 .sp
  60 .LP
  61 The \fBqunbufcall()\fR function can be called from user, interrupt, or kernel
  62 context.
  63 .SH SEE ALSO
  64 .sp
  65 .LP
  66 \fBmt-streams\fR(9F), \fBqbufcall\fR(9F), \fBqtimeout\fR(9F),
  67 \fBquntimeout\fR(9F)
  68 .sp
  69 .LP
  70 \fIWriting Device Drivers\fR
  71 .sp
  72 .LP
  73 \fISTREAMS Programming Guide\fR