dat_ep_set_watermark(3dat)

1dat_ep_set_watermarkD(i3rDeAcTt)Access Transport Library Fudnactt_ieopn_sset_watermark(3DAT)
2
3
4

NAME

6       dat_ep_set_watermark - set high watermark on Endpoint
7

SYNOPSIS

9       cc [ flag... ] file... -ldat [ library... ]
10       #include <dat/udat.h>
11
12       DAT_RETURN
13           dat_ep_set_watermark (
14           IN      DAT_EP_HANDLE      ep_handle,
15           IN      DAT_COUNT          soft_high_watermark,
16           IN      DAT_COUNT          hard_high_watermark
17           )
18
19

PARAMETERS

21       ep_handle              The handle for an instance of an Endpoint.
22
23
24       soft_high_watermark    The  soft  high watermark for the number of Recv
25                              buffers consumed by the Endpoint.
26
27
28       hard_high_watermark    The hard high watermark for the number  of  Recv
29                              buffers consumed by the Endpoint.
30
31

DESCRIPTION

33       The  dat_ep_set_watermark() function sets the soft and hard high water‐
34       mark values for EP and arms EP for generating asynchronous  events  for
35       high  watermarks.  An  asynchronous  event  will  be  generated  for IA
36       async_evd when the number of Recv buffers at EP exceeds the  soft  high
37       watermark  for the first time. A connection broken event will be gener‐
38       ated for EP connect_evd when the number of Recv buffers at  EP  exceeds
39       the  hard  high  watermark. These can occur during this call or when EP
40       takes a buffer from the SRQ or EP RQ. The soft and hard high  watermark
41       asynchronous  event  generation  and  setting  are  independent of each
42       other.
43
44
45       The asynchronous event for a soft high watermark is generated only once
46       per setting. Once an event is generated, no new asynchronous events for
47       the soft high watermark is generated until the EP is again set for  the
48       soft  high  watermark.  If the Consumer is once again interested in the
49       event, the Consumer should again set the soft high watermark.
50
51
52       If the Consumer is not interested in a soft or hard high watermark, the
53       value  of  DAT_WATERMARK_INFINITE can be specified for the case that is
54       the default value. This value specifies that a  non-asynchronous  event
55       will  be  generated  for  a  high watermark EP attribute for which this
56       value is set. It does not prevent generation  of  a  connection  broken
57       event  for EP when no Recv buffer is available for a message arrived on
58       the EP connection.
59
60
61       The operation is supported for all states of Endpoint.
62

RETURN VALUES

64       DAT_SUCCESS                The operation was successful.
65
66
67       DAT_INVALID_HANDLE         The ep_handle argument  is  an  invalid  DAT
68                                  handle.
69
70
71       DAT_INVALID_PARAMETER      One of the parameters is invalid.
72
73
74       DAT_MODEL_NOT_SUPPORTED    The requested Model was not supported by the
75                                  Provider. The Provider does not  support  EP
76                                  Soft or Hard High Watermarks.
77
78

USAGE

80       For  a hard high watermark, the Provider is ready to generate a connec‐
81       tion broken event as soon as the connection is established.
82
83
84       If the asynchronous event for a soft or hard high watermark has not yet
85       been  generated,  this  call  simply  modifies  the  values  for  these
86       attributes. The Provider remains armed for generation  of  these  asyn‐
87       chronous events.
88
89
90       Regardless  of whether an asynchronous event for the soft and hard high
91       watermark has been generated, this operation will set the generation of
92       an asynchronous event with the Consumer-provided high watermark values.
93       If the new high watermark  values  are  below  the  current  number  of
94       Receive  DTOs  at  EP,  an asynchronous event will be generated immedi‐
95       ately. Otherwise the old soft or hard (or both) high  watermark  values
96       are simply replaced with the new ones.
97

ATTRIBUTES

99       See attributes(5) for descriptions of the following attributes:
100
101
102
103
104       ┌─────────────────────────────┬─────────────────────────────┐
105       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
106       ├─────────────────────────────┼─────────────────────────────┤
107       │Interface Stability          │Standard: uDAPL, 1.2         │
108       ├─────────────────────────────┼─────────────────────────────┤
109       │MT-Level                     │Unsafe                       │
110       └─────────────────────────────┴─────────────────────────────┘
111