usr/src/man/man3dat/dat_evd_clear_unwaitable.3dat

   1 '\" te
   2 .\" This manual page is derived from the DAT/uDAPL 1.2 specification.
   3 .\" Portions Copyright (c) 2007, 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 DAT_EVD_CLEAR_UNWAITABLE 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_evd_clear_unwaitable \- transition the Event Dispatcher into a waitable
  10 state
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldat\fR [ \fIlibrary\fR\&.\|.\|. ]
  15 #include <\fBdat/udat.h\fR>
  16
  17 DAT_RETURN
  18     dat_evd_clear_unwaitable(
  19     IN    DAT_EVD_HANDLE    \fIevd_handle\fR
  20     )
  21 .fi
  22
  23 .SH PARAMETERS
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fIevd_handle\fR\fR
  28 .ad
  29 .RS 14n
  30 Handle for an instance of Event Dispatcher.
  31 .RE
  32
  33 .SH DESCRIPTION
  34 .sp
  35 .LP
  36 The \fBdat_evd_clear_unwaitable()\fR transitions the Event Dispatcher into a
  37 waitable state. In this state, calls to \fBdat_evd_wait\fR(3DAT) are permitted
  38 on the EVD. The actual state of the Event Dispatcher is accessible through
  39 \fBdat_evd_query\fR(3DAT) and is \fBDAT_EVD_WAITABLE\fR after the return of
  40 this operation.
  41 .sp
  42 .LP
  43 This call does not affect a CNO associated with this EVD at all. Events
  44 arriving on the EVD after it is set waitable still trigger the CNO (if
  45 appropriate), and can be retrieved with \fBdat_evd_dequeue\fR(3DAT).
  46 .SH RETURN VALUES
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fBDAT_SUCCESS\fR\fR
  51 .ad
  52 .RS 22n
  53 The operation was successful.
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fBDAT_INVALID_HANDLE\fR\fR
  60 .ad
  61 .RS 22n
  62 The \fIevd_handle\fR parameter is invalid.
  63 .RE
  64
  65 .SH ATTRIBUTES
  66 .sp
  67 .LP
  68 See \fBattributes\fR(5) for descriptions of the following attributes:
  69 .sp
  70
  71 .sp
  72 .TS
  73 box;
  74 c | c
  75 l | l .
  76 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  77 _
  78 Interface Stability     Standard: uDAPL, 1.1, 1.2
  79 _
  80 MT-Level        Safe
  81 .TE
  82
  83 .SH SEE ALSO
  84 .sp
  85 .LP
  86 \fBdat_evd_dequeue\fR(3DAT), \fBdat_evd_query\fR(3DAT),
  87 \fBdat_evd_set_unwaitable\fR(3DAT), \fBdat_evd_wait\fR(3DAT),
  88 \fBlibdat\fR(3LIB), \fBattributes\fR(5)