usr/src/man/man3dat/dat_evd_enable.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_ENABLE 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_evd_enable \- enable the Event Dispatcher
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldat\fR [ \fIlibrary\fR\&.\|.\|. ]
  14 #include <\fBdat/udat.h\fR>
  15
  16 DAT_RETURN
  17     dat_evd_enable(
  18     IN    DAT_EVD_HANDLE    \fIevd_handle\fR
  19     )
  20 .fi
  21
  22 .SH PARAMETERS
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fIevd_handle\fR\fR
  27 .ad
  28 .RS 14n
  29 Handle for an instance of Event Dispatcher.
  30 .RE
  31
  32 .SH DESCRIPTION
  33 .sp
  34 .LP
  35 The \fBdat_evd_enable()\fR function enables the Event Dispatcher so that the
  36 arrival of an event can trigger the associated CNO. The enabling and disabling
  37 EVD has no effect on direct waiters on the EVD. However, direct waiters
  38 effectively take ownership of the EVD, so that the specified CNO is not
  39 triggered even if is enabled.
  40 .sp
  41 .LP
  42 If the Event Dispatcher is already enabled, this operation is no-op.
  43 .SH RETURN VALUES
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fBDAT_SUCCESS\fR\fR
  48 .ad
  49 .RS 22n
  50 The operation was successful.
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fBDAT_INVALID_HANDLE\fR\fR
  57 .ad
  58 .RS 22n
  59 The \fIevd_handle\fR parameter is invalid.
  60 .RE
  61
  62 .SH ATTRIBUTES
  63 .sp
  64 .LP
  65 See \fBattributes\fR(5) for descriptions of the following attributes:
  66 .sp
  67
  68 .sp
  69 .TS
  70 box;
  71 c | c
  72 l | l .
  73 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  74 _
  75 Interface Stability     Standard: uDAPL, 1.1, 1.2
  76 _
  77 MT-Level        Safe
  78 .TE
  79
  80 .SH SEE ALSO
  81 .sp
  82 .LP
  83 \fBdat_evd_disable\fR(3DAT), \fBlibdat\fR(3LIB), \fBattributes\fR(5)