dat_srq_set_lw(3dat)

1dat_srq_set_lw(3DAT)Direct Access Transport Library Functiondsat_srq_set_lw(3DAT)
2
3
4

NAME

6       dat_srq_set_lw - set low watermark on shared receive queue
7

SYNOPSIS

9       cc [ flag... ] file... -ldat [ library... ]
10       #include <dat/udat.h>
11
12       DAT_RETURN
13           dat_srq_set_lw (
14               IN      DAT_SRQ_HANDLE      srq_handle,
15               IN      DAT_COUNT           low_watermark
16           )
17
18

PARAMETERS

20       srq_handle       A handle for an instance of a Shared Receive Queue.
21
22
23       low_watermark    The  low  watermark  for the number of Recv buffers on
24                        SRQ.
25
26

DESCRIPTION

28       The dat_srq_set_lw() function sets the low watermark value for the  SRQ
29       and  arms  the  SRQ  for  generating  an asynchronous event for the low
30       watermark. An asynchronous event will be generated when the  number  of
31       buffers  on the SRQ is below the low watermark for the first time. This
32       can occur during the current call or when an associated EP takes a buf‐
33       fer from the SRQ.
34
35
36       The  asynchronous  event will be generated only once per setting of the
37       low watermark. Once an event is generated, no new  asynchronous  events
38       for  the  number of buffers inthe SRQ below the specified value will be
39       generated until the SRQ is again set for the Low Watermark. If the Con‐
40       sumer is again interested in the event, the Consumer should set the low
41       watermark again.
42

RETURN VALUES

44       DAT_SUCCESS                The operation was successful.
45
46
47       DAT_INVALID_HANDLE         The srq_handle argument is  an  invalid  DAT
48                                  handle.
49
50
51       DAT_INVALID_PARAMETER      Invalid  parameter;  the value of low_water‐
52                                  mark is exceeds the value of max_recv_dtos.
53
54
55       DAT_MODEL_NOT_SUPPORTED    The requested Model was not supported by the
56                                  Provider.  The Provider does not support SRQ
57                                  Low Watermark.
58
59

USAGE

61       Upon receiving the asynchronous event for the SRQ  low  watermark,  the
62       Consumer can replenish Recv buffers on the SRQ or take any other action
63       that is appropriate.
64
65
66       Regardless of whether an asynchronous event for the low  watermark  has
67       been  generated, this operation will set the generation of an asynchro‐
68       nous event with the Consumer-provided low watermark value. If  the  new
69       low  watermark  value  is below the current number of free Receive DTOs
70       posted to the SRQ, an asynchronous event will be generated immediately.
71       Otherwise  the  old low watermark value is simply replaced with the new
72       one.
73

ATTRIBUTES

75       See attributes(5) for descriptions of the following attributes:
76
77
78
79
80       ┌─────────────────────────────┬─────────────────────────────┐
81       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
82       ├─────────────────────────────┼─────────────────────────────┤
83       │Interface Stability          │Standard: uDAPL, 1.2         │
84       ├─────────────────────────────┼─────────────────────────────┤
85       │MT-Level                     │Unsafe                       │
86       └─────────────────────────────┴─────────────────────────────┘
87