usr/src/man/man3dat/dat_evd_post_se.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_POST_SE 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_evd_post_se \- post Software event to the Event Dispatcher event queue
  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_post_se(
  18     IN        DAT_EVD_HANDLE    \fIevd_handle\fR,
  19     IN const  DAT_EVENT         *\fIevent\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\fIevent\fR\fR
  37 .ad
  38 .RS 14n
  39 A pointer to a Consumer created Software Event.
  40 .RE
  41
  42 .SH DESCRIPTION
  43 .sp
  44 .LP
  45 The \fBdat_evd_post_se()\fR function posts Software events to the Event
  46 Dispatcher event queue. This is analogous to event arrival on the Event
  47 Dispatcher software Event Stream. The \fIevent\fR that the Consumer provides
  48 adheres to the event format as defined in <\fBdat.h\fR>. The first element in
  49 the \fIevent\fR provides the type of the event (\fBDAT_EVENT_TYPE_SOFTWARE\fR);
  50 the rest provide the event-type-specific parameters. These parameters are
  51 opaque to a Provider. Allocation and release of the memory referenced by the
  52 \fIevent\fR pointer in a software event are the Consumer's responsibility.
  53 .sp
  54 .LP
  55 There is no ordering between events from different Event Streams. All the
  56 synchronization issues between multiple Consumer contexts trying to post events
  57 to an Event Dispatcher instance simultaneously are left to a Consumer.
  58 .sp
  59 .LP
  60 If the event queue is full, the operation is completed unsuccessfully and
  61 returns \fBDAT_QUEUE_FULL\fR. The \fIevent\fR is not queued. The queue overflow
  62 condition does takes place and, therefore, the asynchronous Event Dispatcher is
  63 not effected.
  64 .SH RETURN VALUES
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fBDAT_SUCCESS\fR\fR
  69 .ad
  70 .RS 25n
  71 The operation was successful.
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fBDAT_INVALID_HANDLE\fR\fR
  78 .ad
  79 .RS 25n
  80 The \fIevd_handle\fR parameter is invalid.
  81 .RE
  82
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBDAT_INVALID_PARAMETER\fR\fR
  87 .ad
  88 .RS 25n
  89 The \fIevent\fR parameter is invalid.
  90 .RE
  91
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fBDAT_QUEUE_FULL\fR\fR
  96 .ad
  97 .RS 25n
  98 The Event Dispatcher queue is full.
  99 .RE
 100
 101 .SH ATTRIBUTES
 102 .sp
 103 .LP
 104 See \fBattributes\fR(5) for descriptions of the following attributes:
 105 .sp
 106
 107 .sp
 108 .TS
 109 box;
 110 c | c
 111 l | l .
 112 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 113 _
 114 Interface Stability     Standard: uDAPL, 1.1, 1.2
 115 _
 116 MT-Level        Unsafe
 117 .TE
 118
 119 .SH SEE ALSO
 120 .sp
 121 .LP
 122 \fBlibdat\fR(3LIB), \fBattributes\fR(5)