'\" te
.\"  Copyright 1989 AT&T  Copyright (c) 2006,
.\" Sun Microsystems, Inc.
.\" 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]
.TH ESBBCALL 9F "Jan 16, 2006"
.SH NAME
esbbcall \- call function when buffer is available
.SH SYNOPSIS
.LP
.nf
#include <sys/stream.h>



\fBbufcall_id_t\fR \fBesbbcall\fR(\fBuint_t\fR \fIpri\fR, \fBvoid\fR (\fI*func\fR)(\fIvoid *arg\fR),
     \fBvoid\fR(\fIarg\fR));
.fi

.SH INTERFACE LEVEL
.sp
.LP
Architecture independent level 1 (DDI/DKI).
.SH PARAMETERS
.sp
.ne 2
.na
\fB\fIpri\fR\fR
.ad
.RS 8n
Priority of allocation request (to be used by \fBallocb\fR(9F) function, called
by \fBesbbcall()\fR).
.RE

.sp
.ne 2
.na
\fB\fIfunc\fR\fR
.ad
.RS 8n
Function to be called when buffer becomes available.
.RE

.sp
.ne 2
.na
\fB\fIarg\fR\fR
.ad
.RS 8n
Argument to \fIfunc\fR.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBesbbcall()\fR function, like \fBbufcall\fR(9F), serves as a
\fBtimeout\fR(9F) call of indeterminate length. If \fBesballoc\fR(9F) is unable
to allocate a message and data block header to go with its externally supplied
data buffer, \fBesbbcall()\fR can be used to schedule the routine \fIfunc\fR,
to be called with the argument \fIarg\fR when a buffer becomes available. The
\fIfunc\fR argument can be a routine that calls \fBesballoc\fR(9F) or it may be
another kernel function.
.SH RETURN VALUES
.sp
.LP
On success, a \fBbufcall\fR \fBID\fRis returned. On failure, \fB0\fR is
returned. The value returned from a successful call should be saved for
possible future use with \fBunbufcall()\fR should it become necessary to cancel
the \fBesbbcall()\fR request (as at driver close time).
.SH CONTEXT
.sp
.LP
The \fBesbbcall()\fR function can be called from user, interrupt, or kernel
context.
.SH SEE ALSO
.sp
.LP
\fBallocb\fR(9F), \fBbufcall\fR(9F), \fBesballoc\fR(9F), \fBtimeout\fR(9F),
\fBdatab\fR(9S), \fBunbufcall\fR(9F)
.sp
.LP
\fIWriting Device Drivers\fR \fISTREAMS Programming Guide\fR