usr/src/man/man3dat/dat_ep_set_watermark.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_EP_SET_WATERMARK 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_ep_set_watermark \- set high watermark on Endpoint
  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_ep_set_watermark (
  18     IN      DAT_EP_HANDLE      ep_handle,
  19     IN      DAT_COUNT          soft_high_watermark,
  20     IN      DAT_COUNT          hard_high_watermark
  21     )
  22 .fi
  23
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIep_handle\fR\fR
  29 .ad
  30 .RS 23n
  31 The handle for an instance of an Endpoint.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIsoft_high_watermark\fR\fR
  38 .ad
  39 .RS 23n
  40 The soft high watermark for the number of Recv buffers consumed by the
  41 Endpoint.
  42 .RE
  43
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fIhard_high_watermark\fR\fR
  48 .ad
  49 .RS 23n
  50 The hard high watermark for the number of Recv buffers consumed by the
  51 Endpoint.
  52 .RE
  53
  54 .SH DESCRIPTION
  55 .sp
  56 .LP
  57 The \fBdat_ep_set_watermark()\fR function sets the soft and hard high watermark
  58 values for EP and arms EP for generating asynchronous events for high
  59 watermarks. An asynchronous event will be generated for IA \fIasync_evd\fR when
  60 the number of Recv buffers at EP exceeds the soft high watermark for the first
  61 time. A connection broken event will be generated for EP \fIconnect_evd\fR when
  62 the number of Recv buffers at EP exceeds the hard high watermark. These can
  63 occur during this call or when EP takes a buffer from the SRQ or EP RQ. The
  64 soft and hard high watermark asynchronous event generation and setting are
  65 independent of each other.
  66 .sp
  67 .LP
  68 The asynchronous event for a soft high watermark is generated only once per
  69 setting. Once an event is generated, no new asynchronous events for the soft
  70 high watermark is generated until the EP is again set for the soft high
  71 watermark. If the Consumer is once again interested in the event, the Consumer
  72 should again set the soft high watermark.
  73 .sp
  74 .LP
  75 If the Consumer is not interested in a soft or hard high watermark, the value
  76 of \fBDAT_WATERMARK_INFINITE\fR can be specified for the case that is the
  77 default value. This value specifies that a non-asynchronous event will be
  78 generated for a high watermark EP attribute for which this value is set. It
  79 does not prevent generation of a connection broken event for EP when no Recv
  80 buffer is available for a message arrived on the EP connection.
  81 .sp
  82 .LP
  83 The operation is supported for all states of Endpoint.
  84 .SH RETURN VALUES
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBDAT_SUCCESS\fR\fR
  89 .ad
  90 .RS 27n
  91 The operation was successful.
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fBDAT_INVALID_HANDLE\fR\fR
  98 .ad
  99 .RS 27n
 100 The \fIep_handle\fR argument is an invalid DAT handle.
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fBDAT_INVALID_PARAMETER\fR\fR
 107 .ad
 108 .RS 27n
 109 One of the parameters is invalid.
 110 .RE
 111
 112 .sp
 113 .ne 2
 114 .na
 115 \fB\fBDAT_MODEL_NOT_SUPPORTED\fR\fR
 116 .ad
 117 .RS 27n
 118 The requested Model was not supported by the Provider. The Provider does not
 119 support EP Soft or Hard High Watermarks.
 120 .RE
 121
 122 .SH USAGE
 123 .sp
 124 .LP
 125 For a hard high watermark, the Provider is ready to generate a connection
 126 broken event as soon as the connection is established.
 127 .sp
 128 .LP
 129 If the asynchronous event for a soft or hard high watermark has not yet been
 130 generated, this call simply modifies the values for these attributes. The
 131 Provider remains armed for generation of these asynchronous events.
 132 .sp
 133 .LP
 134 Regardless of whether an asynchronous event for the soft and hard high
 135 watermark has been generated, this operation will set the generation of an
 136 asynchronous event with the Consumer-provided high watermark values. If the new
 137 high watermark values are below the current number of Receive DTOs at EP, an
 138 asynchronous event will be generated immediately. Otherwise the old soft or
 139 hard (or both) high watermark values are simply replaced with the new ones.
 140 .SH ATTRIBUTES
 141 .sp
 142 .LP
 143 See \fBattributes\fR(5) for descriptions of the following attributes:
 144 .sp
 145
 146 .sp
 147 .TS
 148 box;
 149 c | c
 150 l | l .
 151 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 152 _
 153 Interface Stability     Standard: uDAPL, 1.2
 154 _
 155 MT-Level        Unsafe
 156 .TE
 157
 158 .SH SEE ALSO
 159 .sp
 160 .LP
 161 \fBdat_ep_create\fR(3DAT), \fBdat_ep_recv_query\fR(3DAT),
 162 \fBdat_srq_create\fR(3DAT), \fBdat_srq_free\fR(3DAT),
 163 \fBdat_srq_post_recv\fR(3DAT), \fBdat_srq_query\fR(3DAT),
 164 \fBdat_srq_resize\fR(3DAT), \fBdat_srq_set_lw\fR(3DAT), \fBlibdat\fR(3LIB),
 165 \fBattributes\fR(5)