/usr/include/axis2-1.6.0/axis2_op_ctx.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 298 299 300 301 302 303 304 305 306 | /*
* 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_OP_CTX_H
#define AXIS2_OP_CTX_H
/**
* @defgroup axis2_op_ctx operation context
* @ingroup axis2_context
* operation context represents a running "instance" of an operation.
* operation context allows messages to be grouped into operations as in
* WSDL 2.0 specification. operations are essentially arbitrary message exchange
* patterns (MEP). So as messages are being exchanged, operation context remembers
* the state of message exchange pattern specifics.
* The implementation of operation context supports MEPs which have one input
* message and/or one output message. In order to support other MEPs one must
* extend this struct.
* @{
*/
/**
* @file axis2_op_ctx.h
*/
#include <axis2_defines.h>
#include <axutil_hash.h>
#include <axutil_env.h>
#include <axis2_msg_ctx.h>
#include <axis2_op.h>
#ifdef __cplusplus
extern "C"
{
#endif
/** Type name for struct axis2_op_ctx */
typedef struct axis2_op_ctx axis2_op_ctx_t;
struct axis2_svc_ctx;
/**
* Creates an operation context struct instance.
* @param env pointer to environment struct
* @param op pointer to operation that is related to operation context.
* operation context does not assume the ownership of the struct
* @param svc_ctx pointer to parent service context
* @return pointer to newly created operation context
*/
AXIS2_EXTERN axis2_op_ctx_t *AXIS2_CALL
axis2_op_ctx_create(
const axutil_env_t * env,
struct axis2_op *op,
struct axis2_svc_ctx *svc_ctx);
/**
* Gets base which is of context type.
* @param op_ctx pointer to operation context
* @param env pointer to environment struct
* @return pointer to base context
*/
AXIS2_EXTERN axis2_ctx_t *AXIS2_CALL
axis2_op_ctx_get_base(
const axis2_op_ctx_t * op_ctx,
const axutil_env_t * env);
/**
* Frees operation context.
* @param op_ctx pointer to operation context
* @param env pointer to environment struct
* @return void
*/
AXIS2_EXTERN void AXIS2_CALL
axis2_op_ctx_free(
struct axis2_op_ctx *op_ctx,
const axutil_env_t * env);
/**
* Initializes operation context. This method traverses through all the
* message contexts stored within it and initialize them all.
* @param op_ctx pointer to operation context
* @param env pointer to environment struct
* @param conf pointer to conf configuration
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_op_ctx_init(
struct axis2_op_ctx *op_ctx,
const axutil_env_t * env,
struct axis2_conf *conf);
/**
* Gets operation the operation context is related to.
* @param op_ctx pointer to operation context
* @param env pointer to environment struct
* @return pointer to operation
*/
AXIS2_EXTERN struct axis2_op *AXIS2_CALL
axis2_op_ctx_get_op(
const axis2_op_ctx_t * op_ctx,
const axutil_env_t * env);
/**
* Gets parent which is of service context type.
* @param op_ctx pointer to operation context
* @param env pointer to environment struct
* @return pointer to service context within which this operation
* context lives
*/
AXIS2_EXTERN struct axis2_svc_ctx *AXIS2_CALL
axis2_op_ctx_get_parent(
const axis2_op_ctx_t * op_ctx,
const axutil_env_t * env);
/**
* Adds a message context.
* @param op_ctx pointer to operation context
* @param env pointer to environment struct
* @param msg_ctx pointer to message context
* does not assume the ownership of the struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_op_ctx_add_msg_ctx(
struct axis2_op_ctx *op_ctx,
const axutil_env_t * env,
axis2_msg_ctx_t * msg_ctx);
/**
* Gets message context with the given message ID.
* @param op_ctx pointer to operation context
* @param env pointer to environment struct
* @param message_id message label of type axis2_wsdl_msg_labels_t.
* This can be one of AXIS2_WSDL_MESSAGE_LABEL_IN or AXIS2_WSDL_MESSAGE_LABEL_OUT
* from the axis2_wsdl_msg_labels enum.
* @return pointer to message context with given ID
*/
AXIS2_EXTERN axis2_msg_ctx_t *AXIS2_CALL
axis2_op_ctx_get_msg_ctx(
const axis2_op_ctx_t * op_ctx,
const axutil_env_t * env,
const axis2_wsdl_msg_labels_t message_id);
/**
* Gets the bool value indicating if the MEP is complete.
* MEP is considered complete when all the messages that
* are associated with the MEP has arrived.
* @param op_ctx pointer to operation context
* @param env pointer to environment struct
* @return AXIS2_TRUE if MEP invocation is complete, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_op_ctx_get_is_complete(
const axis2_op_ctx_t * op_ctx,
const axutil_env_t * env);
/**
* Sets the bool value indicating if the MEP is complete.
* MEP is considered complete when all the messages that
* are associated with the MEP has arrived.
* @param op_ctx pointer to operating context
* @param env pointer to environment struct
* @param is_complete AXIS2_TRUE if MEP invocation is complete, else
* AXIS2_FALSE
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_op_ctx_set_complete(
struct axis2_op_ctx *op_ctx,
const axutil_env_t * env,
axis2_bool_t is_complete);
/**
* Cleans up the operation context. Clean up includes removing all
* message context references recorded in operation context.
* @param op_ctx pointer to operation context
* @param env pointer to environment struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_op_ctx_cleanup(
struct axis2_op_ctx *op_ctx,
const axutil_env_t * env);
/**
* Sets parent service context.
* @param op_ctx pointer to operation context
* @param env pointer to environment struct
* @param svc_ctx pointer to service context, message context does not
* assume the ownership of the struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_op_ctx_set_parent(
struct axis2_op_ctx *op_ctx,
const axutil_env_t * env,
struct axis2_svc_ctx *svc_ctx);
/**
* Gets the message context map.
* @param op_ctx pointer to operation context
* @param env pointer to environment struct
* @return pointer to hash table containing message contexts
*/
AXIS2_EXTERN axis2_msg_ctx_t **AXIS2_CALL
axis2_op_ctx_get_msg_ctx_map(
const axis2_op_ctx_t * op_ctx,
const axutil_env_t * env);
/**
* Sets the bool value indicating the status of response.
* @param op_ctx pointer to operation context
* @param env pointer to environment struct
* @param response_written AXIS2_TRUE if response is written, else
* AXIS2_FALSE
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_op_ctx_set_response_written(
axis2_op_ctx_t * op_ctx,
const axutil_env_t * env,
const axis2_bool_t response_written);
/**
* Checks the response status, whether it is written or not.
* @param op_ctx pointer to operation context
* @param env pointer to environment struct
* @return AXIS2_TRUE if response is already written, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_op_ctx_get_response_written(
const axis2_op_ctx_t * op_ctx,
const axutil_env_t * env);
/**
* Destroys mutex used to synchronize the read/write operations
* @param op_ctx pointer to operation context
* @param env pointer to environment struct
* @return returns void
*/
AXIS2_EXTERN void AXIS2_CALL
axis2_op_ctx_destroy_mutex(
struct axis2_op_ctx *op_ctx,
const axutil_env_t * env);
/**
* Checks whether op_ctx is in use. This is necessary when destroying the
* thread mutex at the http_worker to check whether the operation context
* is still in use
* @param op_ctx pointer to operation context
* @param env pointer to environment struct
* @return AXIS2_TRUE if still in use, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_op_ctx_is_in_use(
const axis2_op_ctx_t * op_ctx,
const axutil_env_t * env);
/**
* Set operation context's is_in_use attribute. This is necessary when
* destroying the thread mutex at the http_worker to check whether the
* operation context is still in use
* @param op_ctx pointer to operation context
* @param env pointer to environment struct
* @param is_in_use AXIS2_TRUE if still in use, else AXIS2_FALSE
* @return AXIS2_TRUE if still in use, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_op_ctx_set_in_use(
struct axis2_op_ctx *op_ctx,
const axutil_env_t * env,
axis2_bool_t is_in_use);
/**
* Incrementing the op_ctx ref count. This is necessary when
* prevent freeing op_ctx through op_client when it is in use
* as in sandesha where the msg_cts is stored.
* @param op_ctx pointer to operation context
* @param env pointer to environment struct
* @return AXIS2_TRUE if still in use, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_op_ctx_increment_ref(
axis2_op_ctx_t * op_ctx,
const axutil_env_t * env);
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* AXIS2_OP_CTX_H */
|