usr/src/man/man3dat/dat_evd_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_EVD_FREE 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_evd_free \- destroy an instance of 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_free (
  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 the Event Dispatcher.
  30 .RE
  31
  32 .SH DESCRIPTION
  33 .sp
  34 .LP
  35 The \fBdat_evd_free()\fR function destroys a specified instance of the Event
  36 Dispatcher.
  37 .sp
  38 .LP
  39 All events on the queue of the specified Event Dispatcher are lost. The
  40 destruction of the Event Dispatcher instance does not have any effect on any
  41 DAT Objects that originated an Event Stream that had fed events to the Event
  42 Dispatcher instance. There should be no event streams feeding the Event
  43 Dispatcher and no threads blocked on the Event Dispatcher when the EVD is being
  44 closed as at the time when it was created.
  45 .sp
  46 .LP
  47 Use of the handle of the destroyed Event Dispatcher in any consequent operation
  48 fails.
  49 .SH RETURN VALUES
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBDAT_SUCCESS\fR\fR
  54 .ad
  55 .RS 22n
  56 The operation was successful.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBDAT_INVALID_HANDLE\fR\fR
  63 .ad
  64 .RS 22n
  65 The \fIevd_handle\fR parameter is invalid
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fBDAT_INVALID_STATE\fR\fR
  72 .ad
  73 .RS 22n
  74 Invalid parameter. There are Event Streams associated with the Event Dispatcher
  75 feeding it.
  76 .RE
  77
  78 .SH USAGE
  79 .sp
  80 .LP
  81 Consumers are advised to destroy all Objects that originate Event Streams that
  82 feed an instance of the Event Dispatcher before destroying it. An exception to
  83 this rule is Event Dispatchers of an IA.
  84 .sp
  85 .LP
  86 Freeing an IA automatically destroys all Objects associated with it directly
  87 and indirectly, including Event Dispatchers.
  88 .SH ATTRIBUTES
  89 .sp
  90 .LP
  91 See \fBattributes\fR(5) for descriptions of the following attributes:
  92 .sp
  93
  94 .sp
  95 .TS
  96 box;
  97 c | c
  98 l | l .
  99 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 100 _
 101 Interface Stability     Standard: uDAPL, 1.1, 1.2
 102 _
 103 MT-Level        Unsafe
 104 .TE
 105
 106 .SH SEE ALSO
 107 .sp
 108 .LP
 109 \fBlibdat\fR(3LIB), \fBattributes\fR(5)