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
|
/*
* 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_SENDER_H
#define AXIS2_TRANSPORT_SENDER_H
/** @defgroup axis2_transport_sender transport sender
* @ingroup axis2_transport
* Description
* @{
*/
/**
* @file axis2_transport_sender.h
* @brief Axis2 description transport sender interface
*/
#include <axis2_const.h>
#include <axutil_error.h>
#include <axis2_defines.h>
#include <axutil_env.h>
#include <axutil_allocator.h>
#include <axis2_transport_out_desc.h>
#include <axis2_ctx.h>
#include <axis2_msg_ctx.h>
#ifdef __cplusplus
extern "C"
{
#endif
struct axis2_transport_out_desc;
struct axis2_ctx;
struct axis2_msg_ctx;
struct axis2_handler;
/** Type name for struct axis2_transport_sender */
typedef struct axis2_transport_sender axis2_transport_sender_t;
/** Type name for struct axis2_transport_sender_ops */
typedef struct axis2_transport_sender_ops axis2_transport_sender_ops_t;
/**
* @brief Description Transport Sender ops struct
* Encapsulator struct for ops of axis2_transport_sender
*/
struct axis2_transport_sender_ops
{
/**
* Initialize
* @param transport_sender pointer to transport sender
* @param env pointer to environment
* @param conf_ctx pointer to configuration context
* @param transport_out pointer to transport_out
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
axis2_status_t(
AXIS2_CALL
* init)(
axis2_transport_sender_t * transport_sender,
const axutil_env_t * env,
struct axis2_conf_ctx * conf_ctx,
struct axis2_transport_out_desc * transport_out);
/**
* Invoke
* @param transport_sender pointer to transport sender
* @param env pointer to environment struct
* @param msg_ctx pointer to message context
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
axis2_status_t(
AXIS2_CALL
* invoke)(
axis2_transport_sender_t * transport_sender,
const axutil_env_t * env,
struct axis2_msg_ctx * msg_ctx);
/**
* Clean up
* @param transport_sender pointer to transport sender
* @param env pointer to environmnet struct
* @param msg_ctx pointer to message context
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
axis2_status_t(
AXIS2_CALL
* cleanup)(
axis2_transport_sender_t * transport_sender,
const axutil_env_t * env,
struct axis2_msg_ctx * msg_ctx);
/** De-allocate memory
* @param transport_sender pointer to transport sender
* @param env pointer to environment struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
void(
AXIS2_CALL
* free)(
axis2_transport_sender_t * transport_sender,
const axutil_env_t * env);
};
/**
* Transport Sender struct
* This send the SOAP Message to other SOAP nodes and this alone write the SOAP
* Message to the wire. Out flow must be end with one of this kind
*/
struct axis2_transport_sender
{
/** operations of axis transport sender */
const axis2_transport_sender_ops_t *ops;
};
/**
* Creates phase holder struct
* @param env pointer to environment struct
* @return pointer to newly created transport sender
*/
AXIS2_EXTERN axis2_transport_sender_t *AXIS2_CALL
axis2_transport_sender_create(
const axutil_env_t * env);
/*************************** Function macros **********************************/
/** Frees the axis2 transport sender.
@sa axis2_transport_sender_ops#free */
#define AXIS2_TRANSPORT_SENDER_FREE(transport_sender, env) \
((transport_sender->ops)->free (transport_sender, env))
/** Initialize the axis2 transport sender.
@sa axis2_transport_sender_ops#init */
#define AXIS2_TRANSPORT_SENDER_INIT(transport_sender, env, conf_context, transport_out) \
((transport_sender->ops)->init (transport_sender, env, conf_context, transport_out))
/** Invoke.
@sa axis2_transport_sender_ops#invoke */
#define AXIS2_TRANSPORT_SENDER_INVOKE(transport_sender, env, msg_ctx) \
((transport_sender->ops)->invoke (transport_sender, env, msg_ctx))
/** Cleanup.
@sa axis2_transport_sender_ops#cleanup */
#define AXIS2_TRANSPORT_SENDER_CLEANUP(transport_sender, env, msg_ctx) \
((transport_sender->ops)->cleanup (transport_sender, env, msg_ctx))
/*************************** End of function macros ***************************/
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* AXIS2_TRANSPORT_SENDER_H */
|
