/usr/include/axis2-1.6.0/axis2_msg.h is in libaxis2c-dev 1.6.0-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /*
* 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_MSG_H
#define AXIS2_MSG_H
/**
* @defgroup axis2_msg message
* @ingroup axis2_desc
* message represents a message in a WSDL. It captures SOAP headers related to
* a given message, the direction as well as the phases to be invoked along
* the flow. Based on the message direction, there could be only one flow
* associated with a message.
* @{
*/
/**
* @file axis2_msg.h
*/
#include <axutil_param_container.h>
#include <axis2_op.h>
#include <axutil_array_list.h>
#include <axis2_description.h>
#include <axis2_phase_meta.h>
/** Message of IN flow */
#define AXIS2_MSG_IN "in"
/** Message of OUT flow */
#define AXIS2_MSG_OUT "out"
/** Message of IN FAULT flow */
#define AXIS2_MSG_IN_FAULT "InFaultMessage"
/** Message of OUT FAULT flow */
#define AXIS2_MSG_OUT_FAULT "OutFaultMessage"
#ifdef __cplusplus
extern "C"
{
#endif
/** Type name for struct axis2_msg */
typedef struct axis2_msg axis2_msg_t;
/**
* Creates message struct instance.
* @param env pointer to environment struct
* @return pointer to newly created message
*/
AXIS2_EXTERN axis2_msg_t *AXIS2_CALL
axis2_msg_create(
const axutil_env_t * env);
/**
* Frees message.
* @param msg pointer to message
* @param env pointer to environment struct
* @return void
*/
AXIS2_EXTERN void AXIS2_CALL
axis2_msg_free(
axis2_msg_t * msg,
const axutil_env_t * env);
/**
* Adds a parameter.
* @param msg pointer to message
* @param env pointer to environment struct
* @param param pointer to parameter, message assumes ownership of
* parameter
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_add_param(
axis2_msg_t * msg,
const axutil_env_t * env,
axutil_param_t * param);
/**
* Gets the named parameter.
* @param msg pointer to message
* @param env pointer to environment struct
* @param name parameter name string
* @return pointer to parameter corresponding to the same name, returns
* a reference, not a cloned copy
*/
AXIS2_EXTERN axutil_param_t *AXIS2_CALL
axis2_msg_get_param(
const axis2_msg_t * msg,
const axutil_env_t * env,
const axis2_char_t * name);
/**
* Gets all parameters stored in message.
* @param msg pointer to message
* @param env pointer to environment struct
* @return pointer to list of parameters, returns a reference, not a
* cloned copy
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_msg_get_all_params(
const axis2_msg_t * msg,
const axutil_env_t * env);
/**
* Checks if the named parameter is locked.
* @param msg pointer to message
* @param env pointer to environment struct
* @param param_name parameter name string
* @return AXIS2_TRUE if the parameter is locked, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_msg_is_param_locked(
axis2_msg_t * msg,
const axutil_env_t * env,
const axis2_char_t * param_name);
/**
* Sets parent. Parent of a message is of type operation.
* @param msg pointer to message
* @param env pointer to environment struct
* @param op pointer to parent operation, message does not assume
* ownership of parent
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_set_parent(
axis2_msg_t * msg,
const axutil_env_t * env,
axis2_op_t * op);
/**
* Gets parent. Parent of a message is of type operation.
* @param msg pointer to message
* @param env pointer to environment struct
* @return pointer to parent operation, returns a reference, not a
* cloned copy
*/
AXIS2_EXTERN axis2_op_t *AXIS2_CALL
axis2_msg_get_parent(
const axis2_msg_t * msg,
const axutil_env_t * env);
/**
* Gets flow of execution associated with the message.
* @param msg pointer to message
* @param env pointer to environment struct
* @return pointer to array list containing the list of phases
* representing the flow
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_msg_get_flow(
const axis2_msg_t * msg,
const axutil_env_t * env);
/**
* Sets flow of execution associated with the message.
* @param msg pointer to message
* @param env pointer to environment struct
* @param flow pointer to array list of phases representing the flow,
* message assumes ownership of flow
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_set_flow(
axis2_msg_t * msg,
const axutil_env_t * env,
axutil_array_list_t * flow);
/**
* Gets direction of message.
* @param msg pointer to message
* @param env pointer to environment struct
* @return direction string
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_msg_get_direction(
const axis2_msg_t * msg,
const axutil_env_t * env);
/**
* Sets direction of message.
* @param msg pointer to message
* @param env pointer to environment struct
* @param direction pointer to direction
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_set_direction(
axis2_msg_t * msg,
const axutil_env_t * env,
const axis2_char_t * direction);
/**
* Gets QName representing message.
* @param msg pointer to message
* @param env pointer to environment struct
* @return pointer to QName, returns a reference, not a cloned copy
*/
AXIS2_EXTERN const axutil_qname_t *AXIS2_CALL
axis2_msg_get_element_qname(
const axis2_msg_t * msg,
const axutil_env_t * env);
/**
* Sets QName representing message.
* @param msg pointer to message
* @param env pointer to environment struct
* @param element_qname pointer to QName representing message, this
* function creates a clone of QName
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_set_element_qname(
axis2_msg_t * msg,
const axutil_env_t * env,
const axutil_qname_t * element_qname);
/**
* Gets message name.
* @param msg pointer to message
* @param env pointer to environment struct
* @return message name string.
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_msg_get_name(
const axis2_msg_t * msg,
const axutil_env_t * env);
/**
* Sets message name.
* @param msg pointer to message
* @param env pointer to environment struct
* @param name message name string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_set_name(
axis2_msg_t * msg,
const axutil_env_t * env,
const axis2_char_t * name);
/**
* Gets base description.
* @param msg pointer to message
* @param env pointer to environment struct
* @return pointer to base description struct
*/
AXIS2_EXTERN axis2_desc_t *AXIS2_CALL
axis2_msg_get_base(
const axis2_msg_t * msg,
const axutil_env_t * env);
/**
* Gets container of parameters belonging to message.
* @param msg pointer to message
* @param env pointer to environment struct
* @return returns container of parameters
* @sa axutil_param_container
*/
AXIS2_EXTERN axutil_param_container_t *AXIS2_CALL
axis2_msg_get_param_container(
const axis2_msg_t * msg,
const axutil_env_t * env);
/**
* Increments the reference count to this oject
* @param msg pointer to message
* @param env pointer to environment struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_increment_ref(
axis2_msg_t * msg,
const axutil_env_t * env);
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* AXIS2_MSG_H */
|