1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef AXIS2_TRANSPORT_IN_DESC_H
#define AXIS2_TRANSPORT_IN_DESC_H
/**
* @defgroup axis2_transport_in_desc transport in description
* @ingroup axis2_desc
* transport in description represents a transport receiver configured in
* Axis2 configuration. There can be multiple transport receivers configured
* in axis2.xml file and each of them will be represented with a transport
* in description instance. deployment engine takes care of creating and
* instantiating transport in descriptions.
* transport in description encapsulates flows related to the transport in
* and also holds a reference to related transport receiver.
* @{
*/
/**
* @file axis2_transport_in_desc.h
* @brief Axis2 description transport in interface
*/
#include <axis2_const.h>
#include <axutil_error.h>
#include <axis2_defines.h>
#include <axutil_env.h>
#include <axutil_allocator.h>
#include <axutil_array_list.h>
/*#include <axis2_transport_receiver.h>*/
#include <axis2_phase_meta.h>
#include <axis2_phase.h>
#include <axis2_flow.h>
#ifdef __cplusplus
extern "C"
{
#endif
/** Type name for struct axis2_transport_in_desc */
typedef struct axis2_transport_in_desc axis2_transport_in_desc_t;
struct axis2_phase;
struct axis2_transport_receiver;
/**
* Frees transport in description.
* @param transport_in_desc pointer to transport in description struct
* @param env pointer to environment struct
* @return void
*/
AXIS2_EXTERN void AXIS2_CALL
axis2_transport_in_desc_free(
axis2_transport_in_desc_t * transport_in_desc,
const axutil_env_t * env);
/**
* Frees transport in description given as a void parameter.
* @param transport_in pointer to transport in description as a void
* pointer
* @param env pointer to environment struct
* @return void
*/
AXIS2_EXTERN void AXIS2_CALL
axis2_transport_in_desc_free_void_arg(
void *transport_in,
const axutil_env_t * env);
/**
* Gets transport enum.
* @param transport_in pointer to transport in description struct
* @param env pointer to environment struct
* @return transport enum
*/
AXIS2_EXTERN AXIS2_TRANSPORT_ENUMS AXIS2_CALL
axis2_transport_in_desc_get_enum(
const axis2_transport_in_desc_t * transport_in,
const axutil_env_t * env);
/**
* Sets transport enum.
* @param transport_in pointer to transport in description struct
* @param env pointer to environment struct
* @param trans_enum transport enum
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_transport_in_desc_set_enum(
struct axis2_transport_in_desc *transport_in,
const axutil_env_t * env,
const AXIS2_TRANSPORT_ENUMS trans_enum);
/**
* Gets in flow. In flow represents the list of phases invoked
* along the receive path.
* @param transport_in pointer to transport in description struct
* @param env pointer to environment struct
* @return pointer to flow representing in flow, returns a reference,
* not a cloned copy
*/
AXIS2_EXTERN struct axis2_flow *AXIS2_CALL
axis2_transport_in_desc_get_in_flow(
const axis2_transport_in_desc_t * transport_in,
const axutil_env_t * env);
/**
* Sets in flow. In flow represents the list of phases invoked
* along the receive path.
* @param transport_in pointer to transport in description struct
* @param env pointer to environment struct
* @param in_flow pointer to in flow representing in flow, transport in
* description assumes ownership of the flow
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_transport_in_desc_set_in_flow(
struct axis2_transport_in_desc *transport_in,
const axutil_env_t * env,
struct axis2_flow *in_flow);
/**
* Gets fault in flow. Fault in flow represents the list of phases
* invoked along the receive path if a fault happens.
* @param transport_in pointer to transport in description struct
* @param env pointer to environment struct
* @return pointer to flow representing fault in flow, returns a
* reference, not a cloned copy
*/
AXIS2_EXTERN struct axis2_flow *AXIS2_CALL
axis2_transport_in_desc_get_fault_in_flow(
const axis2_transport_in_desc_t * transport_in,
const axutil_env_t * env);
/**
* Sets fault in flow. Fault in flow represents the list of phases
* invoked along the receive path if a fault happens.
* @param transport_in pointer to transport in description struct
* @param env pointer to environment struct
* @param fault_in_flow pointer to flow representing fault in flow,
* transport in description assumes the ownership of the flow
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_transport_in_desc_set_fault_in_flow(
struct axis2_transport_in_desc *transport_in,
const axutil_env_t * env,
struct axis2_flow *fault_in_flow);
/**
* Gets transport receiver associated with the transport in description.
* @param transport_in pointer to transport in description struct
* @param env pointer to environment struct
* @return pointer to transport receiver, returns a reference, not
* a cloned copy
*/
AXIS2_EXTERN struct axis2_transport_receiver *AXIS2_CALL
axis2_transport_in_desc_get_recv(
const axis2_transport_in_desc_t * transport_in,
const axutil_env_t * env);
/**
* Sets transport receiver associated with the transport in description.
* @param transport_in pointer to transport in description struct
* @param env pointer to environment struct
* @param recv pointer to transport receiver, transport in
* description assumes ownership of the receiver
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_transport_in_desc_set_recv(
struct axis2_transport_in_desc *transport_in,
const axutil_env_t * env,
struct axis2_transport_receiver *recv);
/**
* Gets the transport in phase associated with transport in description.
* @param transport_in pointer to transport in description struct
* @param env pointer to environment struct
* @return transport in phase, returns a reference, not a cloned copy
*/
AXIS2_EXTERN struct axis2_phase *AXIS2_CALL
axis2_transport_in_desc_get_in_phase(
const axis2_transport_in_desc_t * transport_in,
const axutil_env_t * env);
/**
* Sets the transport in phase associated with transport in description.
* @param transport_in pointer to transport in description struct
* @param env pointer to environment struct
* @param in_phase pointer to phase representing transport in phase,
* transport in description assumes ownership of phase
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_transport_in_desc_set_in_phase(
struct axis2_transport_in_desc *transport_in,
const axutil_env_t * env,
struct axis2_phase *in_phase);
/**
* Gets the transport fault phase associated with transport in description.
* @param transport_in pointer to transport in description struct
* @param env pointer to environment struct
* @return pointer to phase representing fault phase
*/
AXIS2_EXTERN struct axis2_phase *AXIS2_CALL
axis2_transport_in_desc_get_fault_phase(
const axis2_transport_in_desc_t * transport_in,
const axutil_env_t * env);
/**
* Sets the transport fault phase associated with transport in description.
* @param transport_in pointer to transport in description struct
* @param env pointer to environment struct
* @param fault_phase pointer to fault phase
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_transport_in_desc_set_fault_phase(
struct axis2_transport_in_desc *transport_in,
const axutil_env_t * env,
struct axis2_phase *fault_phase);
/**
* Adds given parameter.
* @param transport_in_desc pointer to transport in description struct
* @param env pointer to environment struct
* @param param pointer to parameter, transport in description assumes
* ownership of parameter
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_transport_in_desc_add_param(
axis2_transport_in_desc_t * transport_in_desc,
const axutil_env_t * env,
axutil_param_t * param);
/**
* Gets named parameter.
* @param transport_in_desc pointer to transport in description struct
* @param env pointer to environment struct
* @param param_name parameter name string
* @return pointer to named parameter if it exists, else NULL. Returns
* a reference, not a cloned copy
*/
AXIS2_EXTERN axutil_param_t *AXIS2_CALL
axis2_transport_in_desc_get_param(
const axis2_transport_in_desc_t * transport_in_desc,
const axutil_env_t * env,
const axis2_char_t * param_name);
/**
* Checks if the named parameter is locked.
* @param transport_in_desc pointer to transport in description struct
* @param env pointer to environment struct
* @param param_name parameter name string
* @return AXIS2_TRUE if named parameter is locked, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_transport_in_desc_is_param_locked(
axis2_transport_in_desc_t * transport_in_desc,
const axutil_env_t * env,
const axis2_char_t * param_name);
AXIS2_EXTERN axutil_param_container_t *AXIS2_CALL
axis2_transport_in_desc_param_container(
const axis2_transport_in_desc_t * transport_in_desc,
const axutil_env_t * env);
/**
* Creates transport in description with given transport enum.
* @param env pointer to environment struct
* @param trans_enum transport enum
* @return pointer to newly created phase holder
*/
AXIS2_EXTERN axis2_transport_in_desc_t *AXIS2_CALL
axis2_transport_in_desc_create(
const axutil_env_t * env,
const AXIS2_TRANSPORT_ENUMS trans_enum);
/**
* Frees transport in description given as a void parameter.
* @param transport_in pointer to transport in description as a void
* pointer
* @param env pointer to environment struct
* @return void
*/
AXIS2_EXTERN void AXIS2_CALL
axis2_transport_in_desc_free_void_arg(
void *transport_in,
const axutil_env_t * env);
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* AXIS2_TRANSPORT_IN_DESC_H */
|
