share/man/man9f/pollwakeup.9f

   1 '\" te
   2 .\"  Copyright 1989 AT&T
   3 .\"  Copyright (c) 2006, Sun Microsystems, Inc.,  All Rights Reserved
   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 POLLWAKEUP 9F "Jan 16, 2006"
   8 .SH NAME
   9 pollwakeup \- inform a process that an event has occurred
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/poll.h>
  14
  15
  16
  17 \fBvoid\fR \fBpollwakeup\fR(\fBstruct pollhead *\fR\fIphp\fR, \fBshort\fR \fIevent\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\fIphp\fR\fR
  29 .ad
  30 .RS 9n
  31 Pointer to a \fBpollhead\fR structure.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIevent\fR\fR
  38 .ad
  39 .RS 9n
  40 Event to notify the process about.
  41 .RE
  42
  43 .SH DESCRIPTION
  44 .sp
  45 .LP
  46 The \fBpollwakeup()\fR function wakes a process waiting on the occurrence of an
  47 event. It should be called from a driver for each occurrence of an event. The
  48 \fBpollhead\fR structure will usually be associated with the driver's private
  49 data structure associated with the particular minor device where the event has
  50 occurred. See \fBchpoll\fR(9E) and \fBpoll\fR(2) for more detail.
  51 .SH CONTEXT
  52 .sp
  53 .LP
  54 The \fBpollwakeup()\fR function can be called from user, interrupt, or kernel
  55 context.
  56 .SH SEE ALSO
  57 .sp
  58 .LP
  59 \fBpoll\fR(2), \fBchpoll\fR(9E)
  60 .sp
  61 .LP
  62 \fIWriting Device Drivers\fR
  63 .SH NOTES
  64 .sp
  65 .LP
  66 Driver defined locks should not be held across calls to this function.