1dat_ep_modify(3DAT)Direct Access Transport Library Functionsdat_ep_modify(3DAT)
2
3
4

NAME

6       dat_ep_modify - change parameters of an Endpoint
7

SYNOPSIS

9       cc [ flag... ] file... -ldat [ library... ]
10       #include <dat/udat.h>
11
12       DAT_RETURN
13           dat_ep_modify (
14           IN    DAT_EP_HANDLE        ep_handle,
15           IN    DAT_EP_PARAM_MASK    ep_param_mask,
16           IN    DAT_EP_PARAM         *ep_param
17           )
18
19

PARAMETERS

21       ep_handle        Handle for an instance of the Endpoint.
22
23
24       ep_param_mask    Mask for Endpoint parameters.
25
26
27       ep_param         Pointer  to the Consumer-allocated structure that con‐
28                        tains Consumer-requested Endpoint parameters.
29
30

DESCRIPTION

32       The dat_ep_modify() function provides the  Consumer  a  way  to  change
33       parameters of an Endpoint.
34
35
36       The  ep_param_mask  parameter allows Consumers to specify which parame‐
37       ters to modify. Providers modify  values  for  ep_param_mask  requested
38       parameters only.
39
40
41       Not  all  the  parameters  of the Endpoint can be modified. Some can be
42       modified only when the Endpoint is in a specific state.  The  following
43       list  specifies  which  parameters can be modified and when they can be
44       modified.
45
46       Interface Adapter
47
48           Cannot be modified.
49
50           Endpoint belongs to an open instance of  IA  and  that  association
51           cannot be changed.
52
53
54       Endpoint State
55
56           Cannot be modified.
57
58           State of Endpoint cannot be changed by a dat_ep_modify() operation.
59
60
61       Local IA Address
62
63           Cannot be modified.
64
65           Local IA Address cannot be changed by a dat_ep_modify() operation.
66
67
68       Local Port Qualifier
69
70           Cannot be modified.
71
72           Local  port qualifier cannot be changed by a dat_ep_modify() opera‐
73           tion.
74
75
76       Remote IA Address
77
78           Cannot be modified.
79
80           Remote IA Address cannot be changed by a dat_ep_modify() operation.
81
82
83       Remote Port Qualifier
84
85           Cannot be modified.
86
87           Remote port qualifier cannot be changed by a dat_ep_modify() opera‐
88           tion
89
90
91       Protection Zone
92
93           Can  be modified when in Quiescent, Unconnected, and Tentative Con‐
94           nection Pending states.
95
96           Protection Zone can be changed only when the Endpoint is in  quies‐
97           cent  state.  The  only  Endpoint states that isare quiescent isare
98           DAT_EP_STATE_UNCONNECTED     and     DAT_EP_STATE_TENTATIVE_CONNEC‐
99           TION_PENDING.  Consumers should be aware that any Receive DTOs cur‐
100           rently posted to the Endpoint that do not match the new  Protection
101           Zone fail with a DAT_PROTECTION_VIOLATION return.
102
103
104       In DTO Event Dispatcher
105
106           Can  be  modified when in Unconnected, Reserved, Passive Connection
107           Request Pending, and Tentative Connection Pending states.
108
109           Event Dispatcher for incoming DTOs (Receive) can  be  changed  only
110           prior  to a request for a connection for an Active side or prior to
111           accepting a Connection Request for a Passive side.
112
113
114       Out DTO Event Dispatcher
115
116           Can be modified when in Unconnected, Reserved,  Passive  Connection
117           Pending, and Tentative Connection Pending states.
118
119           Event  Dispatcher  for  outgoing  DTOs  (Send,  RDMA Read, and RDMA
120           Write) can be changed only prior to a request for a connection  for
121           an  Active  side  or  prior to accepting a Connection Request for a
122           Passive side.
123
124
125       Connection Event Dispatcher
126
127           Can be modified when in Unconnected, Reserved,  Passive  Connection
128           Pending, and Tentative Connection Pending states.
129
130           Event  Dispatcher for the Endpoint Connection events can be changed
131           only prior to a request for a connection  for  an  Active  side  or
132           accepting a Connection Request for a Passive side.
133
134
135       Service Type
136
137           Can  be  modified when in Unconnected, Reserved, Passive Connection
138           Pending, and Tentative Connection Pending states.
139
140           Service Type can be changed only prior to a request for  a  connec‐
141           tion  for  an  Active  side or accepting a Connection Request for a
142           Passive side.
143
144
145       Maximum Message Size
146
147           Can be modified when in Unconnected, Reserved,  Passive  Connection
148           Request Pending, and Tentative Connection Pending states.
149
150           Maximum  Message  Size can be changed only prior to a request for a
151           connection for an Active side or accepting a Connection Request for
152           a Passive side.
153
154
155       Maximum RDMA Size
156
157           Can  be  modified when in Unconnected, Reserved, Passive Connection
158           Pending, and Tentative Connection Pending states.
159
160           Maximum RDMA Size can be changed only prior to a request for a con‐
161           nection  for an Active side or accepting a Connection Request for a
162           Passive side.
163
164
165       Quality of Service
166
167           Can be modified when in Unconnected, Reserved,  Passive  Connection
168           Pending, and Tentative Connection Pending states.
169
170           QoS  can be changed only prior to a request for a connection for an
171           Active side or accepting a Connection Request for a Passive side.
172
173
174       Recv Completion Flags
175
176           Can be modified when in Unconnected, Reserved,  Passive  Connection
177           Pending, and Tentative Connection Pending states.
178
179           Recv  Completion Flags specifies what DTO flags the Endpoint should
180           support for Receive DTO operations. The value  can  be  DAT_COMPLE‐
181           TION_NOTIFICATION_SUPPRESS_FLAG,                        DAT_COMPLE‐
182           TION_SOLICITED_WAIT_FLAG,   or   DAT_COMPLETION_EVD_THRESHOLD_FLAG.
183           Recv  posting  does  not  support  DAT_COMPLETION_SUPPRESS_FLAG  or
184           DAT_COMPLETION_BARRIER_FENCE_FLAG dat_completion_flags values  that
185           are  only applicable to Request postings. Recv Completion Flags can
186           be changed only prior to a request for a connection for  an  Active
187           side  or  accepting  a  Connection  Request for a Passive side, but
188           before posting of any Recvs.
189
190
191       Request Completion Flags
192
193           Can be modified when in Unconnected, Reserved,  Passive  Connection
194           Request Pending, and Tentative Connection Pending states.
195
196           Request  Completion  Flags  specifies  what  DTO flags the Endpoint
197           should support for Send, RDMA Read, RDMA Write, and RMR Bind opera‐
198           tions.   The   value  can  be:  DAT_COMPLETION_UNSIGNALLED_FLAG  or
199           DAT_COMPLETION_EVD_THRESHOLD_FLAG. Request postings always  support
200           DAT_COMPLETION_SUPPRESS_FLAG,   DAT_COMPLETION_SOLICITED_WAIT_FLAG,
201           or   DAT_COMPLETION_BARRIER_FENCE_FLAG   completion_flags   values.
202           Request Completion Flags can be changed only prior to a request for
203           a connection for an Active side or accepting a  Connection  Request
204           for a Passive side.
205
206
207       Maximum Recv DTO
208
209           Can  be  modified when in Unconnected, Reserved, Passive Connection
210           Pending, and Tentative Connection Pending states.
211
212           Maximum Recv DTO specifies the maximum number of  outstanding  Con‐
213           sumer-submitted Receive DTOs that a Consumer expects at any time at
214           the Endpoint. Maximum Recv DTO can  be  changed  only  prior  to  a
215           request  for a connection for an Active side or accepting a Connec‐
216           tion Request for a Passive side.
217
218
219       Maximum Request DTO
220
221           Can be modified when in Unconnected, Reserved,  Passive  Connection
222           Pending, and Tentative Connection Pending states.
223
224           Maximum  Request  DTO  specifies  the maximum number of outstanding
225           Consumer-submitted send and RDMA DTOs and RMR Binds that a Consumer
226           expects at any time at the Endpoint. Maximum Out DTO can be changed
227           only prior to a request for a connection  for  an  Active  side  or
228           accepting a Connection Request for a Passive side.
229
230
231       Maximum Recv IOV
232
233           Can  be  modified when in Unconnected, Reserved, Passive Connection
234           Pending, and Tentative Connection Pending states.
235
236           Maximum Recv IOV specifies the maximum number of  elements  in  IOV
237           that  a  Consumer  specifies for posting a Receive DTO for the End‐
238           point. Maximum Recv IOV can be changed only prior to a request  for
239           a  connection  for an Active side or accepting a Connection Request
240           for a Passive side.
241
242
243       Maximum Request IOV
244
245           Can be modified when in Unconnected, Reserved,  Passive  Connection
246           Pending, and Tentative Connection Pending states.
247
248           Maximum Request IOV specifies the maximum number of elements in IOV
249           that a Consumer specifies for posting a Send, RDMA  Read,  or  RDMA
250           Write DTO for the Endpoint. Maximum Request IOV can be changed only
251           prior to a request for a connection for an Active side or accepting
252           a Connection Request for a Passive side.
253
254
255       Maximum outstanding RDMA Read as target
256
257           Can  be  modified when in Unconnected, Reserved, Passive Connection
258           Pending, and Tentative Connection Pending states.
259
260           Maximum number of outstanding RDMA Reads for which the Endpoint  is
261           the target.
262
263
264       Maximum outstanding RDMA Read as originator
265
266           Can  be  modified when in Unconnected, Reserved, Passive Connection
267           Pending, and Tentative Connection Pending states.
268
269           Maximum number of outstanding RDMA Reads for which the Endpoint  is
270           the originator.
271
272
273       Num transport-specific attributes
274
275           Can be modified when in Quiescent (unconnected) state.
276
277           Number of transport-specific attributes to be modified.
278
279
280       Transport-specific endpoint attributes
281
282           Can be modified when in Quiescent (unconnected) state.
283
284           Transport-specific  attributes  can  be modified only in the trans‐
285           port-defined Endpoint state. The  only  guaranteed  safe  state  in
286           which  to modify transport-specific Endpoint attributes is the qui‐
287           escent state DAT_EP_STATE_UNCONNECTED.
288
289
290       Num provider-specific attributes
291
292           Can be modified when in Quiescent (unconnected) state.
293
294            Number of Provider-specific attributes to be modified.
295
296
297       Provider-specific endpoint attributes
298
299           Can be modified when in Quiescent (unconnected) state.
300
301           Provider-specific attributes can be modified only in the  Provider-
302           defined  Endpoint state. The only guaranteed safe state in which to
303           modify Provider-specific Endpoint attributes is the quiescent state
304           DAT_EP_STATE_UNCONNECTED.
305
306

RETURN VALUES

308       DAT_SUCCESS              The operation was successful.
309
310
311       DAT_INVALID_HANDLE       The ep_handle parameter is invalid.
312
313
314       DAT_INVALID_PARAMETER    The ep_param_mask parameter is invalid, or one
315                                of  the  requested  Endpoint   parameters   or
316                                attributes was invalid, not supported, or can‐
317                                not be modified.
318
319
320       DAT_INVALID_STATE        Parameter in an invalid  state.  The  Endpoint
321                                was  not  in  the state that allows one of the
322                                parameters or attributes to be modified.
323
324

ATTRIBUTES

326       See attributes(5) for descriptions of the following attributes:
327
328
329
330
331       ┌─────────────────────────────┬─────────────────────────────┐
332       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
333       ├─────────────────────────────┼─────────────────────────────┤
334       │Interface Stability          │Standard: uDAPL, 1.1, 1.2    │
335       ├─────────────────────────────┼─────────────────────────────┤
336       │MT-Level                     │Unsafe                       │
337       └─────────────────────────────┴─────────────────────────────┘
338

SEE ALSO

340       libdat(3LIB), attributes(5)
341
342
343
344SunOS 5.11                        16 Jul 2004              dat_ep_modify(3DAT)