usr/src/man/man3dat/dat_evd_modify_cno.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_MODIFY_CNO 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_evd_modify_cno \- change the associated CNO for 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_modify_cno (
  18     IN    DAT_EVD_HANDLE    \fIevd_handle\fR,
  19     IN    DAT_CNO_HANDLE    \fIcno_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 the Event Dispatcher.
  31 .RE
  32
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fIcno_handle\fR\fR
  37 .ad
  38 .RS 14n
  39 Handle for a CNO. The value of \fBDAT_NULL_HANDLE\fR specifies no CNO.
  40 .RE
  41
  42 .SH DESCRIPTION
  43 .sp
  44 .LP
  45 The \fBdat_evd_modify_cno()\fR function changes the associated CNO for the
  46 Event Dispatcher.
  47 .sp
  48 .LP
  49 A Consumer can specify the value of \fBDAT_HANDLE_NULL\fR for \fIcno_handle\fR
  50 to associate not CNO with the Event Dispatcher instance.
  51 .sp
  52 .LP
  53 Upon completion of the \fBdat_evd_modify_cno()\fR operation, the passed IN new
  54 CNO is used for notification. During the operation, an event arrival can be
  55 delivered to the old or new CNO. If Notification is generated by EVD, it is
  56 delivered to the new or old CNO.
  57 .sp
  58 .LP
  59 If the EVD is enabled at the time \fBdat_evd_modify_cno()\fR is called, the
  60 Consumer must be prepared to collect a notification event on the EVD's old CNO
  61 as well as the new one. Checking immediately prior to calling
  62 \fBdat_evd_modify_cno()\fR is not adequate. A notification could have been
  63 generated after the prior check and before the completion of the change.
  64 .sp
  65 .LP
  66 The Consumer can avoid the risk of missed notifications either by temporarily
  67 disabling the EVD, or by checking the prior CNO after invoking this operation.
  68 The Consumer can disable EVD before a \fBdat_evd_modify_cno()\fR call and
  69 enable it afterwards. This ensures that any notifications from the EVD are
  70 delivered to the new CNO only.
  71 .sp
  72 .LP
  73 If this function is used to disassociate a CNO from the EVD, events arriving on
  74 this EVD might cause waiters on that CNO to awaken after returning from this
  75 routine because of unblocking a CNO waiter already "in progress" at the time
  76 this routine is called. If this is the case, the events causing that unblocking
  77 are present on the EVD upon return from the \fBdat_evd_modify_cno()\fR call and
  78 can be dequeued at that time
  79 .SH RETURN VALUES
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBDAT_SUCCESS\fR\fR
  84 .ad
  85 .RS 22n
  86 The operation was successful.
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fBDAT_INVALID_HANDLE\fR\fR
  93 .ad
  94 .RS 22n
  95 Invalid DAT handle.
  96 .RE
  97
  98 .SH ATTRIBUTES
  99 .sp
 100 .LP
 101 See \fBattributes\fR(5) for descriptions of the following attributes:
 102 .sp
 103
 104 .sp
 105 .TS
 106 box;
 107 c | c
 108 l | l .
 109 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 110 _
 111 Interface Stability     Standard: uDAPL, 1.1, 1.2
 112 _
 113 MT-Level        Unsafe
 114 .TE
 115
 116 .SH SEE ALSO
 117 .sp
 118 .LP
 119 \fBlibdat\fR(3LIB), \fBattributes\fR(5)