share/man/man9f/unbufcall.9f

   1 '\" te
   2 .\"  Copyright 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 UNBUFCALL 9F "Jan 16, 2006"
   8 .SH NAME
   9 unbufcall \- cancel a pending bufcall request
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/stream.h>
  14
  15
  16
  17 \fBvoid\fR \fBunbufcall\fR(\fBbufcall_id_t\fR \fIid\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\fIid\fR\fR
  29 .ad
  30 .RS 6n
  31 Identifier returned from \fBbufcall\fR(9F) or \fBesbbcall\fR(9F).
  32 .RE
  33
  34 .SH DESCRIPTION
  35 .sp
  36 .LP
  37 The \fBunbufcall\fR function cancels a pending \fBbufcall()\fR or
  38 \fBesbbcall()\fR request. The argument \fBid\fR is a non-zero identifier for
  39 the request to be cancelled. \fBid\fR is returned from the \fBbufcall()\fR or
  40 \fBesbbcall()\fR function used to issue the request. \fBunbufcall()\fR will not
  41 return until the pending callback is cancelled or has run. Because of this,
  42 locks acquired by the callback routine should not be held across the call to
  43 \fBunbufcall()\fR or deadlock may result.
  44 .SH RETURN VALUES
  45 .sp
  46 .LP
  47 None.
  48 .SH CONTEXT
  49 .sp
  50 .LP
  51 The \fBunbufcall\fR function can be called from user, interrupt, or kernel
  52 context.
  53 .SH SEE ALSO
  54 .sp
  55 .LP
  56 \fBbufcall\fR(9F), \fBesbbcall\fR(9F)
  57 .sp
  58 .LP
  59 \fIWriting Device Drivers\fR
  60 .sp
  61 .LP
  62 \fISTREAMS Programming Guide\fR