usr/src/man/man3dat/dat_evd_set_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_SET_UNWAITABLE 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_evd_set_unwaitable \- transition the Event Dispatcher into an unwaitable
  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_set_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_set_unwaitable()\fR transitions the Event Dispatcher into an
  37 unwaitable state. In this state, calls to \fBdat_evd_wait\fR(3DAT) return
  38 synchronously with a \fBDAT_INVALID_STATE\fR error, and threads already blocked
  39 in \fBdat_evd_wait()\fR are awakened and return with a \fBDAT_INVALID_STATE\fR
  40 error without any further action by the Consumer. The actual state of the Event
  41 Dispatcher is accessible through \fBdat_evd_query\fR(3DAT) and is
  42 \fBDAT_EVD_UNWAITABLE\fR after the return of this operation.
  43 .sp
  44 .LP
  45 This call does not affect a CNO associated with this EVD at all. Events
  46 arriving on the EVD after it is set unwaitable still trigger the CNO (if
  47 appropriate), and can be retrieved with \fBdat_evd_dequeue\fR(3DAT). Because
  48 events can arrive normally on the EVD, the EVD might overflow; the Consumer is
  49 expected to protect against this possibility.
  50 .SH RETURN VALUES
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fBDAT_SUCCESS\fR\fR
  55 .ad
  56 .RS 22n
  57 The operation was successful.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBDAT_INVALID_HANDLE\fR\fR
  64 .ad
  65 .RS 22n
  66 The \fIevd_handle\fR parameter is invalid.
  67 .RE
  68
  69 .SH ATTRIBUTES
  70 .sp
  71 .LP
  72 See \fBattributes\fR(5) for descriptions of the following attributes:
  73 .sp
  74
  75 .sp
  76 .TS
  77 box;
  78 c | c
  79 l | l .
  80 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  81 _
  82 Interface Stability     Standard: uDAPL, 1.1, 1.2
  83 _
  84 MT-Level        Safe
  85 .TE
  86
  87 .SH SEE ALSO
  88 .sp
  89 .LP
  90 \fBdat_evd_clear_unwaitable\fR(3DAT), \fBdat_evd_dequeue\fR(3DAT),
  91 \fBdat_evd_query\fR(3DAT), \fBdat_evd_wait\fR(3DAT), \fBlibdat\fR(3LIB),
  92 \fBattributes\fR(5)