xref: /illumos-gate/usr/src/man/man9f/esbbcall.9f (revision 09fcda9fe16a733cc35aa3156a47ef4b909251a6)
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]
ESBBCALL 9F "Jan 16, 2006"
NAME
esbbcall - call function when buffer is available
SYNOPSIS

#include <sys/stream.h>



bufcall_id_t esbbcall(uint_t pri, void (*func)(void *arg),
 void(arg));
INTERFACE LEVEL

Architecture independent level 1 (DDI/DKI).

PARAMETERS
pri

Priority of allocation request (to be used by allocb(9F) function, called by esbbcall()).

func

Function to be called when buffer becomes available.

arg

Argument to func.

DESCRIPTION

The esbbcall() function, like bufcall(9F), serves as a timeout(9F) call of indeterminate length. If esballoc(9F) is unable to allocate a message and data block header to go with its externally supplied data buffer, esbbcall() can be used to schedule the routine func, to be called with the argument arg when a buffer becomes available. The func argument can be a routine that calls esballoc(9F) or it may be another kernel function.

RETURN VALUES

On success, a bufcall IDis returned. On failure, 0 is returned. The value returned from a successful call should be saved for possible future use with unbufcall() should it become necessary to cancel the esbbcall() request (as at driver close time).

CONTEXT

The esbbcall() function can be called from user, interrupt, or kernel context.

SEE ALSO

allocb(9F), bufcall(9F), esballoc(9F), timeout(9F), datab(9S), unbufcall(9F)

Writing Device Drivers STREAMS Programming Guide