share/man/man3dat/dat_cno_free.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_CNO_FREE 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_cno_free \- destroy an instance of the CNO
  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_cno_free (
  18     IN    DAT_CNO_HANDLE    \fIcno_handle\fR
  19     )
  20 .fi
  21
  22 .SH PARAMETERS
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fIcno_handle\fR\fR
  27 .ad
  28 .RS 14n
  29 Handle for an instance of the CNO
  30 .RE
  31
  32 .SH DESCRIPTION
  33 .sp
  34 .LP
  35 The \fBdat_cno_free()\fR function destroys a specified instance of the CNO.
  36 .sp
  37 .LP
  38 A CNO cannot be deleted while it is referenced by an Event Dispatcher or while
  39 a thread is blocked on it.
  40 .SH RETURN VALUES
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fBDAT_SUCCESS\fR\fR
  45 .ad
  46 .RS 22n
  47 The operation was successful.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBDAT_INVALID_HANDLE\fR\fR
  54 .ad
  55 .RS 22n
  56 The \fBcno_handle()\fR parameter is invalid.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBDAT_INVALID_STATE\fR\fR
  63 .ad
  64 .RS 22n
  65 Parameter in an invalid state. CNO is in use by an EVD instance or there is a
  66 thread blocked on it.
  67 .RE
  68
  69 .SH USAGE
  70 .sp
  71 .LP
  72 If there is a thread blocked in \fBdat_cno_wait\fR(3DAT), the Consumer can do
  73 the following steps to unblock the waiter:
  74 .RS +4
  75 .TP
  76 .ie t \(bu
  77 .el o
  78 Create a temporary EVD that accepts software events. It can be created in
  79 advance.
  80 .RE
  81 .RS +4
  82 .TP
  83 .ie t \(bu
  84 .el o
  85 For a CNO with the waiter, attach that EVD to the CNO and post the software
  86 event on the EVD.
  87 .RE
  88 .RS +4
  89 .TP
  90 .ie t \(bu
  91 .el o
  92 This unblocks the CNO.
  93 .RE
  94 .RS +4
  95 .TP
  96 .ie t \(bu
  97 .el o
  98 Repeat for other CNOs that have blocked waiters.
  99 .RE
 100 .RS +4
 101 .TP
 102 .ie t \(bu
 103 .el o
 104 Destroy the temporary EVD after all CNOs are destroyed and the EVD is no longer
 105 needed.
 106 .RE
 107 .SH ATTRIBUTES
 108 .sp
 109 .LP
 110 See \fBattributes\fR(5) for descriptions of the following attributes:
 111 .sp
 112
 113 .sp
 114 .TS
 115 box;
 116 c | c
 117 l | l .
 118 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 119 _
 120 Interface Stability     Standard: uDAPL, 1.1, 1.2
 121 _
 122 MT-Level        Unsafe
 123 .TE
 124
 125 .SH SEE ALSO
 126 .sp
 127 .LP
 128 \fBdat_cno_wait\fR(3DAT), \fBlibdat\fR(3LIB), \fBattributes\fR(5)