dat_rsp_create(3dat)

1dat_rsp_create(3DAT)Direct Access Transport Library Functiondsat_rsp_create(3DAT)
2
3
4

NAME

6       dat_rsp_create - create a Reserved Service Point
7

SYNOPSIS

9       cc [ flag... ] file... -ldat [ library... ]
10       #include <dat/udat.h>
11
12       DAT_RETURN
13           dat_rsp_create (
14           IN    DAT_IA_HANDLE    ia_handle,
15           IN    DAT_CONN_QUAL    conn_qual,
16           IN    DAT_EP_HANDLE    ep_handle,
17           IN    DAT_EVD_HANDLE   evd_handle,
18           OUT   DAT_RSP_HANDLE   *rsp_handle
19           )
20
21

PARAMETERS

23       ia_handle     Handle for an instance of DAT IA.
24
25
26       conn_qual     Connection Qualifier of the IA the Reserved Service Point
27                     listens to.
28
29
30       ep_handle     Handle for the Endpoint associated with the Reserved Ser‐
31                     vice  Point  that  is the only Endpoint that can accept a
32                     Connection Request  on  this  Service  Point.  The  value
33                     DAT_HANDLE_NULL  requests  the  Provider  to  associate a
34                     Provider-created Endpoint with this Service Point.
35
36
37       evd_handle    The Event Dispatcher to  which  an  event  of  Connection
38                     Request arrival is generated.
39
40
41       rsp_handle    Handle to an opaque Reserved Service Point.
42
43

DESCRIPTION

45       The dat_rsp_create() function creates a Reserved Service Point with the
46       specified Endpoint that generates, at most, one Connection Request that
47       is delivered to the specified Event Dispatcher in a Notification event.
48

RETURN VALUES

50       DAT_SUCCESS                   The operation was successful.
51
52
53       DAT_INSUFFICIENT_RESOURCES    The operation failed due to resource lim‐
54                                     itations.
55
56
57       DAT_INVALID_HANDLE            The ia_handle, evd_handle,  or  ep_handle
58                                     parameter is invalid.
59
60
61       DAT_INVALID_PARAMETER         The conn_qual parameter is invalid.
62
63
64       DAT_INVALID_STATE             Parameter  in an invalid state. For exam‐
65                                     ple, an Endpoint  was  not  in  the  Idle
66                                     state.
67
68
69       DAT_CONN_QUAL_IN_USE          Specified Connection Qualifier is in use.
70
71

USAGE

73       The usage of a Reserve Service Point is as follows:
74
75           o      The  DAT Consumer creates a Local Endpoint and configures it
76                  appropriately.
77
78           o      The DAT Consumer creates a Reserved Service Point specifying
79                  the Local Endpoint.
80
81           o      The Reserved Service Point performs the following:
82
83               o      Collects   native  transport  information  reflecting  a
84                      received Connection Request.
85
86               o      Creates a Pending Connection Request.
87
88               o      Creates  a  Connection  Request  Notice   (event)   that
89                      includes the Pending Connection Request (which includes,
90                      among others, Reserved Service Point  Connection  Quali‐
91                      fier,  its  Local Endpoint, and information about remote
92                      Endpoint).
93
94               o      Delivers the Connection Request Notice to the  Consumer-
95                      specified target (CNO) evd_handle. The Local Endpoint is
96                      transitioned from Reserved to Passive Connection Pending
97                      state.
98
99           o      Upon  receiving a connection request, or at some time subse‐
100                  quent to that, the DAT  Consumer  must  either  accept()  or
101                  reject() the Pending Connection Request.
102
103           o      If  accepted,  the  original Local Endpoint is now in a Con‐
104                  nected state and fully usable for this  connection,  pending
105                  only  native  transport mandated RTU messages. This includes
106                  binding it to the IA port if that was not  done  previously.
107                  The Consumer is notified that the Endpoint is in a Connected
108                  state by a Connection Established Event on the Endpoint con‐
109                  nect_evd_handle.
110
111           o      If  rejected,  the  Local  Endpoint  point  transitions into
112                  Unconnected state. The DAT Consumer can elect to destroy  it
113                  or reuse it for other purposes.
114

ATTRIBUTES

116       See attributes(5) for descriptions of the following attributes:
117
118
119
120
121       ┌─────────────────────────────┬─────────────────────────────┐
122       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
123       ├─────────────────────────────┼─────────────────────────────┤
124       │Interface Stability          │Standard: uDAPL, 1.1, 1.2    │
125       ├─────────────────────────────┼─────────────────────────────┤
126       │MT-Level                     │Safe                         │
127       └─────────────────────────────┴─────────────────────────────┘
128