8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man3dat / dat_srq_set_lw.3dat
blobd2dfd711d85f2a04224fc59d222ddc9cdd013a63
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_SRQ_SET_LW 3DAT "Jul 16, 2004"
8 .SH NAME
9 dat_srq_set_lw \- set low watermark on shared receive 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>
16 DAT_RETURN
17     dat_srq_set_lw (
18         IN      DAT_SRQ_HANDLE      srq_handle,
19         IN      DAT_COUNT           low_watermark
20     )
21 .fi
23 .SH PARAMETERS
24 .sp
25 .ne 2
26 .na
27 \fB\fIsrq_handle\fR\fR
28 .ad
29 .RS 17n
30 A handle for an instance of a Shared Receive Queue.
31 .RE
33 .sp
34 .ne 2
35 .na
36 \fB\fIlow_watermark\fR\fR
37 .ad
38 .RS 17n
39 The low watermark for the number of Recv buffers on SRQ.
40 .RE
42 .SH DESCRIPTION
43 .sp
44 .LP
45 The \fBdat_srq_set_lw()\fR function sets the low watermark value for the SRQ
46 and arms the SRQ for generating an asynchronous event for the low watermark. An
47 asynchronous event will be generated when the number of buffers on the SRQ is
48 below the low watermark for the first time. This can occur during the current
49 call or when an associated EP takes a buffer from the SRQ.
50 .sp
51 .LP
52 The asynchronous event will be generated only once per setting of the low
53 watermark. Once an event is generated, no new asynchronous events for the
54 number of buffers inthe SRQ below the specified value will be generated until
55 the SRQ is again set for the Low Watermark. If the Consumer is again interested
56 in the event, the Consumer should set the low watermark again.
57 .SH RETURN VALUES
58 .sp
59 .ne 2
60 .na
61 \fB\fBDAT_SUCCESS\fR\fR
62 .ad
63 .RS 27n
64 The operation was successful.
65 .RE
67 .sp
68 .ne 2
69 .na
70 \fB\fBDAT_INVALID_HANDLE\fR\fR
71 .ad
72 .RS 27n
73 The \fIsrq_handle\fR argument is an invalid DAT handle.
74 .RE
76 .sp
77 .ne 2
78 .na
79 \fB\fBDAT_INVALID_PARAMETER\fR\fR
80 .ad
81 .RS 27n
82 Invalid parameter; the value of \fIlow_watermark\fR is exceeds the value of
83 \fImax_recv_dtos\fR.
84 .RE
86 .sp
87 .ne 2
88 .na
89 \fB\fBDAT_MODEL_NOT_SUPPORTED\fR\fR
90 .ad
91 .RS 27n
92 The requested Model was not supported by the Provider. The Provider does not
93 support SRQ Low Watermark.
94 .RE
96 .SH USAGE
97 .sp
98 .LP
99 Upon receiving the asynchronous event for the SRQ low watermark, the Consumer
100 can replenish Recv buffers on the SRQ or take any other action that is
101 appropriate.
104 Regardless of whether an asynchronous event for the low watermark has been
105 generated, this operation will set the generation of an asynchronous event with
106 the Consumer-provided low watermark value. If the new low watermark value is
107 below the current number of free Receive DTOs posted to the SRQ, an
108 asynchronous event will be generated immediately. Otherwise the old low
109 watermark value is simply replaced with the new one.
110 .SH ATTRIBUTES
113 See \fBattributes\fR(5) for descriptions of the following attributes:
118 box;
119 c | c
120 l | l .
121 ATTRIBUTE TYPE  ATTRIBUTE VALUE
123 Interface Stability     Standard: uDAPL, 1.2
125 MT-Level        Unsafe
128 .SH SEE ALSO
131 \fBdat_srq_create\fR(3DAT), \fBdat_srq_free\fR(3DAT),
132 \fBdat_srq_post_recv\fR(3DAT), \fBdat_srq_query\fR(3DAT),
133 \fBdat_srq_resize\fR(3DAT), \fBlibdat\fR(3LIB), \fBattributes\fR(5)