share/man/man3dat/dat_evd_disable.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_DISABLE 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_evd_disable \- disable 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_disable(
  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_disable()\fR function disables the Event Dispatcher so that the
  36 arrival of an event does not affect the associated CNO.
  37 .sp
  38 .LP
  39 If the Event Dispatcher is already disabled, this operation is no-op.
  40 .sp
  41 .LP
  42 Events arriving on this EVD might cause waiters on the associated CNO to be
  43 awakened after the return of this routine because an unblocking a CNO waiter is
  44 already "in progress" at the time this routine is called or returned.
  45 .SH RETURN VALUES
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fBDAT_SUCCESS\fR\fR
  50 .ad
  51 .RS 22n
  52 The operation was successful.
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fBDAT_INVALID_HANDLE\fR\fR
  59 .ad
  60 .RS 22n
  61 The \fIevd_handle\fR parameter is invalid.
  62 .RE
  63
  64 .SH ATTRIBUTES
  65 .sp
  66 .LP
  67 See \fBattributes\fR(5) for descriptions of the following attributes:
  68 .sp
  69
  70 .sp
  71 .TS
  72 box;
  73 c | c
  74 l | l .
  75 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  76 _
  77 Interface Stability     Standard: uDAPL, 1.1, 1.2
  78 _
  79 MT-Level        Safe
  80 .TE
  81
  82 .SH SEE ALSO
  83 .sp
  84 .LP
  85 \fBdat_evd_enable\fR(3DAT), \fBlibdat\fR(3LIB), \fBattributes\fR(5)