/usr/include/axis2-1.6.0/axis2_phase.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 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 | /*
* 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_PHASE_H
#define AXIS2_PHASE_H
/**
* @defgroup axis2_phase phases
* @ingroup axis2_engine
* phase is a logical unit of execution in the Axis2 engine's execution flows.
* A phase encapsulates one or more handlers in a given sequence to be invoked.
* The sequencing of handlers within a phase are often defined by module
* configuration which specifies where in the phase's handler chain a given
* handler should be placed.
* Calling invoke on phase triggers invoke on the handlers stored within the
* phase in the sequence they are ordered.
* @{
*/
/**
* @file axis2_phase.h
*/
#include <axis2_defines.h>
#include <axutil_env.h>
#include <axis2_handler.h>
#include <axis2_handler_desc.h>
#include <axutil_array_list.h>
#include <axutil_qname.h>
/**
* A given handler's location within the list of handlers is before a particular
* handler and after another particular handler.
*/
#define AXIS2_PHASE_BOTH_BEFORE_AFTER 0
/**
* A given handler's location within the list of handlers is before another
* given handler.
*/
#define AXIS2_PHASE_BEFORE 1
/**
* A given handler's location within the list of handlers is after another
* given handler.
*/
#define AXIS2_PHASE_AFTER 2
/**
* A given handler's location within the list of handlers could be anywhere in
* the list.
*/
#define AXIS2_PHASE_ANYWHERE 3
#ifdef __cplusplus
extern "C"
{
#endif
/** Type name for axis2_phase */
typedef struct axis2_phase axis2_phase_t;
struct axis2_msg_ctx;
/**
* Adds given handler to the specified position in the handler array list.
* @param phase pointer to phase struct
* @param env pointer to environment struct
* @param index index
* @param handler pointer to handler, phase does not assume the
* ownership of the handler
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_phase_add_handler_at(
axis2_phase_t * phase,
const axutil_env_t * env,
const int index,
axis2_handler_t * handler);
/**
* Adds the given handler to the end of the handler list.
* @param phase pointer to phase
* @param env pointer to environment struct
* @param handler pointer to handler, phase does not assume the
* ownership of the handler
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_phase_add_handler(
axis2_phase_t * phase,
const axutil_env_t * env,
axis2_handler_t * handler);
/**
* Remove the given handler from the handler list.
* @param phase pointer to phase
* @param env pointer to environment struct
* @param handler pointer to handler, phase does not assume the
* ownership of the handler
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_phase_remove_handler(
axis2_phase_t * phase,
const axutil_env_t * env,
axis2_handler_t * handler);
/**
* Invokes the phase. This function will in turn call invoke method of
* each handler in the handler list, in sequence, starting from the
* beginning of the list to the end of the list.
* @param phase pointer to phase
* @param env pointer to environment struct
* @param msg_ctx pointer to message context
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_phase_invoke(
axis2_phase_t * phase,
const axutil_env_t * env,
struct axis2_msg_ctx *msg_ctx);
/**
* Gets phase name.
* @param phase pointer to phase
* @param env pointer to environment struct
* @return returns name of phase
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_phase_get_name(
const axis2_phase_t * phase,
const axutil_env_t * env);
/**
* Gets handler count in the handler list.
* @param phase pointer to phase
* @param env pointer to environment struct
* @return the number of handlers in the handler list
*/
AXIS2_EXTERN int AXIS2_CALL
axis2_phase_get_handler_count(
const axis2_phase_t * phase,
const axutil_env_t * env);
/**
* Sets the first handler in the handler list.
* @param phase pointer to phase
* @param env pointer to environment struct
* @param handler pointer to handler, phase does not assume the
* ownership of the handler
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_phase_set_first_handler(
axis2_phase_t * phase,
const axutil_env_t * env,
axis2_handler_t * handler);
/**
* Sets the last handler in the handler list.
* @param phase pointer to phase
* @param env pointer to environment struct
* @param handler pointer to handler, phase does not assume the
* ownership of the handler
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_phase_set_last_handler(
axis2_phase_t * phase,
const axutil_env_t * env,
axis2_handler_t * handler);
/**
* Adds handler within the handler description to the list of handlers
* in the phase.
* @param phase pointer to phase
* @param env pointer to environment struct
* @param handler_desc pointer to handler description, phase does not
* assume the ownership of neither the handler description not the handler
* within the handler description
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_phase_add_handler_desc(
axis2_phase_t * phase,
const axutil_env_t * env,
axis2_handler_desc_t * handler_desc);
/**
* Remove handler within the handler description from the list of handlers
* in the phase.
* @param phase pointer to phase
* @param env pointer to environment struct
* @param handler_desc pointer to handler description, phase does not
* assume the ownership of neither the handler description not the handler
* within the handler description
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_phase_remove_handler_desc(
axis2_phase_t * phase,
const axutil_env_t * env,
axis2_handler_desc_t * handler_desc);
/**
* Inserts the handler into handler list of the phase based on the phase
* rules associated with the handler. This function takes into account
* the before rules of the handler. Before rules specify the location
* of a current handler in the handler list, before which the given
* handler is to be placed.
* @param phase pointer to phase
* @param env pointer to environment struct
* @param handler pointer to handler, phase does not assume the
* ownership of the handler
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_phase_insert_before(
axis2_phase_t * phase,
const axutil_env_t * env,
axis2_handler_t * handler);
/**
* Inserts the handler into handler list of the phase based on the phase
* rules associated with the handler. This function takes into account
* the after rules of the handler. After rules specify the location
* of a current handler in the handler list, after which the given
* handler is to be placed.
* @param phase pointer to phase
* @param env pointer to environment struct
* @param handler pointer to handler, phase does not assume the
* ownership of the handler
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_phase_insert_after(
axis2_phase_t * phase,
const axutil_env_t * env,
axis2_handler_t * handler);
/**
* Inserts the handler into handler list of the phase based on both
* before and after phase rules associated with the handler.
* This method assume that both the before and after cannot be the same
* handler . That condition is not checked by this function.
* It should be checked before calling this function
* @param phase pointer to phase
* @param env pointer to environment struct
* @param handler pointer to handler, phase does not assume the
* ownership of the handler
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_phase_insert_before_and_after(
axis2_phase_t * phase,
const axutil_env_t * env,
axis2_handler_t * handler);
/**
* Inserts the handler to the correct location in the handler list of
* the phase. Location is evaluated based on the phase rules.
* @param phase pointer to phase
* @param env pointer to environment struct
* @param handler_desc pointer to handler description, phase does not
* assume the ownership of neither the handler description not the handler
* within the handler description
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_phase_insert_handler_desc(
axis2_phase_t * phase,
const axutil_env_t * env,
axis2_handler_desc_t * handler_desc);
/**
* Gets all the handlers in the phase.
* @param phase pointer to phase
* @param env pointer to environment struct
* @return pointer to array list containing the list of handlers
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_phase_get_all_handlers(
const axis2_phase_t * phase,
const axutil_env_t * env);
/**
* Invokes handlers starting from the given handler index.
* @param phase pointer to phase
* @param env pointer to environment struct
* @param paused_handler_index index of the handler to start the
* invocation from
* @param msg_ctx pointer to message context
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_phase_invoke_start_from_handler(
axis2_phase_t * phase,
const axutil_env_t * env,
const int paused_handler_index,
struct axis2_msg_ctx *msg_ctx);
/**
* Frees phase struct.
* @param phase pointer to phase
* @param env pointer to environment struct
* @return void
*/
AXIS2_EXTERN void AXIS2_CALL
axis2_phase_free(
axis2_phase_t * phase,
const axutil_env_t * env);
/**
* creates phase struct instance.
* @param env pointer to environment struct
* @param phase_name name of the phase to be created
* @return pointer to newly created phase
*/
AXIS2_EXTERN axis2_phase_t *AXIS2_CALL
axis2_phase_create(
const axutil_env_t * env,
const axis2_char_t * phase_name);
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_phase_increment_ref(
axis2_phase_t * phase,
const axutil_env_t * env);
#ifdef __cplusplus
}
#endif
#endif /* AXIS2_PHASE_H */
|