usr/src/man/man9f/esbbcall.9f

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 2006,
   3 .\" Sun Microsystems, Inc.
   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 ESBBCALL 9F "Jan 16, 2006"
   8 .SH NAME
   9 esbbcall \- call function when buffer is available
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/stream.h>
  14
  15
  16
  17 \fBbufcall_id_t\fR \fBesbbcall\fR(\fBuint_t\fR \fIpri\fR, \fBvoid\fR (\fI*func\fR)(\fIvoid *arg\fR),
  18      \fBvoid\fR(\fIarg\fR));
  19 .fi
  20
  21 .SH INTERFACE LEVEL
  22 .sp
  23 .LP
  24 Architecture independent level 1 (DDI/DKI).
  25 .SH PARAMETERS
  26 .sp
  27 .ne 2
  28 .na
  29 \fB\fIpri\fR\fR
  30 .ad
  31 .RS 8n
  32 Priority of allocation request (to be used by \fBallocb\fR(9F) function, called
  33 by \fBesbbcall()\fR).
  34 .RE
  35
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fIfunc\fR\fR
  40 .ad
  41 .RS 8n
  42 Function to be called when buffer becomes available.
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fIarg\fR\fR
  49 .ad
  50 .RS 8n
  51 Argument to \fIfunc\fR.
  52 .RE
  53
  54 .SH DESCRIPTION
  55 .sp
  56 .LP
  57 The \fBesbbcall()\fR function, like \fBbufcall\fR(9F), serves as a
  58 \fBtimeout\fR(9F) call of indeterminate length. If \fBesballoc\fR(9F) is unable
  59 to allocate a message and data block header to go with its externally supplied
  60 data buffer, \fBesbbcall()\fR can be used to schedule the routine \fIfunc\fR,
  61 to be called with the argument \fIarg\fR when a buffer becomes available. The
  62 \fIfunc\fR argument can be a routine that calls \fBesballoc\fR(9F) or it may be
  63 another kernel function.
  64 .SH RETURN VALUES
  65 .sp
  66 .LP
  67 On success, a \fBbufcall\fR \fBID\fRis returned. On failure, \fB0\fR is
  68 returned. The value returned from a successful call should be saved for
  69 possible future use with \fBunbufcall()\fR should it become necessary to cancel
  70 the \fBesbbcall()\fR request (as at driver close time).
  71 .SH CONTEXT
  72 .sp
  73 .LP
  74 The \fBesbbcall()\fR function can be called from user, interrupt, or kernel
  75 context.
  76 .SH SEE ALSO
  77 .sp
  78 .LP
  79 \fBallocb\fR(9F), \fBbufcall\fR(9F), \fBesballoc\fR(9F), \fBtimeout\fR(9F),
  80 \fBdatab\fR(9S), \fBunbufcall\fR(9F)
  81 .sp
  82 .LP
  83 \fIWriting Device Drivers\fR \fISTREAMS Programming Guide\fR