callback
[client API]


Files

file  axis2_callback.h

Classes

struct  axis2_callback_ops
struct  axis2_callback

Defines

#define AXIS2_CALLBACK_INVOKE_ON_COMPLETE(callback, env, result)   ((callback)->ops->invoke_on_complete(callback, env, result))
#define AXIS2_CALLBACK_ON_COMPLETE(callback, env)   ((callback)->ops->on_complete(callback, env))
#define AXIS2_CALLBACK_REPORT_ERROR(callback, env, error)   ((callback)->ops->report_error(callback, env, error))
#define AXIS2_CALLBACK_ON_ERROR(callback, env, error)   ((callback)->ops->on_error(callback, env, error))
#define AXIS2_CALLBACK_GET_COMPLETE(callback, env)   ((callback)->ops->get_complete(callback, env))
#define AXIS2_CALLBACK_SET_COMPLETE(callback, env, complete)   ((callback)->ops->set_complete(callback, env, complete))
#define AXIS2_CALLBACK_GET_ENVELOPE(callback, env)   ((callback)->ops->get_envelope(callback, env))
#define AXIS2_CALLBACK_SET_ENVELOPE(callback, env, envelope)   ((callback)->ops->set_envelope(callback, env, envelope))
#define AXIS2_CALLBACK_GET_ERROR(callback, env)   ((callback)->ops->get_error(callback, env))
#define AXIS2_CALLBACK_SET_ERROR(callback, env, error)   ((callback)->ops->set_error(callback, env, error))
#define AXIS2_CALLBACK_GET_DATA(callback)   ((callback)->ops->get_data(callback))
#define AXIS2_CALLBACK_SET_DATA(callback, data)   ((callback)->ops->set_data(callback, data))
#define AXIS2_CALLBACK_SET_ON_COMPLETE(callback, func)   ((callback)->ops->set_on_complete(callback, func))
#define AXIS2_CALLBACK_SET_ON_ERROR(callback, func)   ((callback)->ops->set_on_error(callback, func))
#define AXIS2_CALLBACK_FREE(callback, env)   ((callback)->ops->free (callback, env))

Typedefs

typedef axis2_callback_ops axis2_callback_ops_t
typedef axis2_callback axis2_callback_t
typedef axis2_status_t(* on_complete_func_ptr )(axis2_callback_t *, const axis2_env_t *)
typedef axis2_status_t(* on_error_func_ptr )(axis2_callback_t *, const axis2_env_t *, int)

Functions

AXIS2_EXTERN axis2_callback_taxis2_callback_create (const axis2_env_t *env)

Detailed Description

callback represents the callback mechanisms to be used in case of asynchronous invocations. It holds the complete status of the invocation, the resulting SOAP envelope and also callback specific data. One can define a function to be called on complete of the callback as well as a function to be called on error.

Define Documentation

#define AXIS2_CALLBACK_FREE callback,
env   )     ((callback)->ops->free (callback, env))
 

Frees callback struct.

See also:
axis2_callback_ops::free

#define AXIS2_CALLBACK_GET_COMPLETE callback,
env   )     ((callback)->ops->get_complete(callback, env))
 

Gets complete status.

See also:
axis2_callback_ops::get_complete

#define AXIS2_CALLBACK_GET_DATA callback   )     ((callback)->ops->get_data(callback))
 

Gets data.

See also:
axis2_callback_ops::get_data

#define AXIS2_CALLBACK_GET_ENVELOPE callback,
env   )     ((callback)->ops->get_envelope(callback, env))
 

Gets result SOAP envelope.

See also:
axis2_callback_ops::get_envelope

#define AXIS2_CALLBACK_GET_ERROR callback,
env   )     ((callback)->ops->get_error(callback, env))
 

Gets error code.

See also:
axis2_callback_ops::get_error

#define AXIS2_CALLBACK_INVOKE_ON_COMPLETE callback,
env,
result   )     ((callback)->ops->invoke_on_complete(callback, env, result))
 

Invokes on complete functions.

See also:
axis2_callback_ops::invoke_on_complete

#define AXIS2_CALLBACK_ON_COMPLETE callback,
env   )     ((callback)->ops->on_complete(callback, env))
 

Function to be called on complete of callback.

See also:
axis2_callback_ops::on_complete

#define AXIS2_CALLBACK_ON_ERROR callback,
env,
error   )     ((callback)->ops->on_error(callback, env, error))
 

Function to be called on error of callback.

See also:
axis2_callback_ops::on_error

#define AXIS2_CALLBACK_REPORT_ERROR callback,
env,
error   )     ((callback)->ops->report_error(callback, env, error))
 

Reports error.

See also:
axis2_callback_ops::report_error

#define AXIS2_CALLBACK_SET_COMPLETE callback,
env,
complete   )     ((callback)->ops->set_complete(callback, env, complete))
 

Sets complete status.

See also:
axis2_callback_ops::set_complete

#define AXIS2_CALLBACK_SET_DATA callback,
data   )     ((callback)->ops->set_data(callback, data))
 

Sets data.

See also:
axis2_callback_ops::set_data

#define AXIS2_CALLBACK_SET_ENVELOPE callback,
env,
envelope   )     ((callback)->ops->set_envelope(callback, env, envelope))
 

Sets SOAP envelope.

See also:
axis2_callback_ops::set_envelope

#define AXIS2_CALLBACK_SET_ERROR callback,
env,
error   )     ((callback)->ops->set_error(callback, env, error))
 

Sets error code.

See also:
axis2_callback_ops::set_error

#define AXIS2_CALLBACK_SET_ON_COMPLETE callback,
func   )     ((callback)->ops->set_on_complete(callback, func))
 

Sets on complete callback function.

See also:
axis2_callback_ops::set_on_complete

#define AXIS2_CALLBACK_SET_ON_ERROR callback,
func   )     ((callback)->ops->set_on_error(callback, func))
 

Set on error callback function.

See also:
axis2_callback_ops::set_on_error


Typedef Documentation

typedef struct axis2_callback_ops axis2_callback_ops_t
 

Type name for axis2_callback_ops

typedef struct axis2_callback axis2_callback_t
 

Type name for axis2_callback

typedef axis2_status_t( * on_complete_func_ptr)(axis2_callback_t *, const axis2_env_t *)
 

Type name for function pointer to be called on complete of callback

typedef axis2_status_t( * on_error_func_ptr)(axis2_callback_t *, const axis2_env_t *, int)
 

Type name for function pointer to be called on error of callback


Function Documentation

AXIS2_EXTERN axis2_callback_t* axis2_callback_create const axis2_env_t env  ) 
 

Creates a callback struct.

Parameters:
env pointer to environment struct
Returns:
pointer to newly created callback struct


Generated on Thu Aug 31 17:32:41 2006 for Axis2/C by  doxygen 1.4.6