share/man/man3dat/dat_evd_resize.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_RESIZE 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_evd_resize \- modify the size of the event queue of 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_resize(
  18     IN    DAT_EVD_HANDLE    \fIevd_handle\fR,
  19     IN    DAT_COUNT         \fIevd_min_qlen\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 16n
  30 Handle for an instance of Event Dispatcher.
  31 .RE
  32
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fIevd_min_qlen\fR\fR
  37 .ad
  38 .RS 16n
  39 New number of events the Event Dispatcher event queue must hold.
  40 .RE
  41
  42 .SH DESCRIPTION
  43 .sp
  44 .LP
  45 The \fBdat_evd_resize()\fR function modifies the size of the event queue of
  46 Event Dispatcher.
  47 .sp
  48 .LP
  49 Resizing of Event Dispatcher event queue should not cause any incoming or
  50 current events on the event queue to be lost. If the number of entries on the
  51 event queue is larger then the requested evd_min_qlen\fI\fR, the operation can
  52 return \fBDAT_INVALID_STATE\fR and not change an instance of Event Dispatcher
  53 .SH RETURN VALUES
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBDAT_SUCCESS\fR\fR
  58 .ad
  59 .RS 30n
  60 The operation was successful.
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBDAT_INVALID_HANDLE\fR\fR
  67 .ad
  68 .RS 30n
  69 The \fIevd_handle\fR parameter is invalid.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBDAT_INVALID_PARAMETER\fR\fR
  76 .ad
  77 .RS 30n
  78 The \fIevd_min_qlen\fR parameter is invalid
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBDAT_INSUFFICIENT_RESOURCES\fR\fR
  85 .ad
  86 .RS 30n
  87 The operation failed due to resource limitations
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBDAT_INVALID_STATE\fR\fR
  94 .ad
  95 .RS 30n
  96 Invalid parameter. The number of entries on the event queue of the Event
  97 Dispatcher exceeds the requested event queue length.
  98 .RE
  99
 100 .SH USAGE
 101 .sp
 102 .LP
 103 This operation is useful when the potential number of events that could be
 104 placed on the event queue changes dynamically.
 105 .SH ATTRIBUTES
 106 .sp
 107 .LP
 108 See \fBattributes\fR(5) for descriptions of the following attributes:
 109 .sp
 110
 111 .sp
 112 .TS
 113 box;
 114 c | c
 115 l | l .
 116 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 117 _
 118 Interface Stability     Standard: uDAPL, 1.1, 1.2
 119 _
 120 MT-Level        Unsafe
 121 .TE
 122
 123 .SH SEE ALSO
 124 .sp
 125 .LP
 126 \fBlibdat\fR(3LIB), \fBattributes\fR(5)