utils
[utilities]


Files

file  axis2_utils.h

Defines

#define AXIS2_FUNC_PARAM_CHECK(object, env, error_return)
#define AXIS2_PARAM_CHECK(error, object, error_return)
#define AXIS2_ERROR_SET(error, error_number, status_code)
#define AXIS2_CREATE_FUNCTION   "axis2_get_instance"
#define AXIS2_DELETE_FUNCTION   "axis2_remove_instance"
#define AXIS2_REQUEST_URL_PREFIX   "/services"

Typedefs

typedef int(*) AXIS2_FREE_VOID_ARG (void *obj_to_be_freed, const axis2_env_t *env)
typedef int(*) AXIS2_READ_INPUT_CALLBACK (char *buffer, int size, void *ctx)
typedef int(*) AXIS2_CLOSE_INPUT_CALLBACK (void *ctx)

Enumerations

enum  axis2_scopes { AXIS2_SCOPE_APPLICATION = 0, AXIS2_SCOPE_SESSION, AXIS2_SCOPE_REQUEST }
 Axis2 scopes. More...

Functions

AXIS2_EXTERN axis2_char_t ** axis2_parse_request_url_for_svc_and_op (const axis2_env_t *env, const axis2_char_t *request)

Define Documentation

#define AXIS2_CREATE_FUNCTION   "axis2_get_instance"

Method names in the loadable libraries

#define AXIS2_ERROR_SET ( error,
error_number,
status_code   ) 

Value:

{ \
        AXIS2_ERROR_SET_ERROR_NUMBER(error, error_number); \
        AXIS2_ERROR_SET_STATUS_CODE(error, status_code); \
    }
This macro is used to handle error situation.
Parameters:
error_number Error number for the error occured
error_return If function return a status it should pass here AXIS2_FAILURE. If function return a type pointer it should pass NULL
Returns:
If function return a status code return AXIS2_SUCCESS. Else if function return a type pointer return NULL

#define AXIS2_FUNC_PARAM_CHECK ( object,
env,
error_return   ) 

Value:

AXIS2_ENV_CHECK(env, error_return);\
    if (!object) \
    { \
        AXIS2_ERROR_SET_ERROR_NUMBER(env->error, AXIS2_ERROR_INVALID_NULL_PARAM); \
        AXIS2_ERROR_SET_STATUS_CODE(env->error, AXIS2_FAILURE); \
        return error_return; \
    } \
    else \
    { \
        AXIS2_ERROR_SET_STATUS_CODE(env->error, AXIS2_SUCCESS); \
    }
This macro is called to check whether structure on which function is called is NULL and to check whether the environment structure passed is valid.
Parameters:
object structure on which function is called
env environment to be checked for validity
error_return If function return a status it should pass here AXIS2_FAILURE. If function return a type pointer it should pass NULL
Returns:
If function return a status code return AXIS2_SUCCESS. Else if function return a type pointer return NULL

#define AXIS2_PARAM_CHECK ( error,
object,
error_return   ) 

Value:

if (!object) \
    { \
        AXIS2_ERROR_SET_ERROR_NUMBER(error, AXIS2_ERROR_INVALID_NULL_PARAM); \
        AXIS2_ERROR_SET_STATUS_CODE(error, AXIS2_FAILURE); \
        return error_return; \
    } \
    else \
    { \
        AXIS2_ERROR_SET_STATUS_CODE(error, AXIS2_SUCCESS); \
    }
This macro is called to check whether an object is NULL. if object is NULL error number and status code is set
Parameters:
object object to be check for NULL
error_return If function return a status it should pass here AXIS2_FAILURE. If function return a type pointer it should pass NULL
Returns:
If function return a status code return AXIS2_SUCCESS. Else if function return a type pointer return NULL


Enumeration Type Documentation

enum axis2_scopes

Axis2 scopes.

Possible scope value for Axis2

Enumerator:
AXIS2_SCOPE_APPLICATION  Application scope
AXIS2_SCOPE_SESSION  Session scope
AXIS2_SCOPE_REQUEST  Request scope


Function Documentation

AXIS2_EXTERN axis2_char_t** axis2_parse_request_url_for_svc_and_op ( const axis2_env_t env,
const axis2_char_t *  request 
)

This function allows users to reolve the service and op from the url. It returns an array of 2 elements of axis2_char_t arrays (strings). The caller is responsible to free the memory allocated by the function for the return value.

Parameters:
request url
Returns:
axis2_char_t ** axis2_char_t **


Generated on Tue Oct 3 20:48:11 2006 for Axis2/C by  doxygen 1.4.7