axis2_callback_ops Struct Reference
[callback]

#include <axis2_callback.h>

List of all members.

Public Attributes

axis2_status_t(* invoke_on_complete )(axis2_callback_t *callback, const axis2_env_t *env, axis2_async_result_t *result)
axis2_status_t(* on_complete )(axis2_callback_t *callback, const axis2_env_t *env)
axis2_status_t(* report_error )(axis2_callback_t *callback, const axis2_env_t *env, const int exception)
axis2_status_t(* on_error )(axis2_callback_t *callback, const axis2_env_t *env, const int exception)
axis2_bool_t(* get_complete )(const axis2_callback_t *callback, const axis2_env_t *env)
axis2_status_t(* set_complete )(axis2_callback_t *callback, const axis2_env_t *env, const axis2_bool_t complete)
axiom_soap_envelope_t *(* get_envelope )(const axis2_callback_t *callback, const axis2_env_t *env)
axis2_status_t(* set_envelope )(axis2_callback_t *callback, const axis2_env_t *env, axiom_soap_envelope_t *envelope)
int(* get_error )(const axis2_callback_t *callback, const axis2_env_t *env)
axis2_status_t(* set_error )(axis2_callback_t *callback, const axis2_env_t *env, const int error)
axis2_status_t(* set_data )(axis2_callback_t *callback, void *data)
void *(* get_data )(const axis2_callback_t *callback)
void(* set_on_complete )(axis2_callback_t *callback, axis2_on_complete_func_ptr f)
void(* set_on_error )(axis2_callback_t *callback, axis2_on_error_func_ptr f)
axis2_status_t(* free )(axis2_callback_t *callback, const axis2_env_t *env)


Detailed Description

callback ops struct. Encapsulator struct for ops of axis2_callback.


Member Data Documentation

axis2_status_t( * axis2_callback_ops::free)(axis2_callback_t *callback, const axis2_env_t *env)

Frees callback struct.

Parameters:
callback pointer to callback struct
env pointer to environment struct
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_bool_t( * axis2_callback_ops::get_complete)(const axis2_callback_t *callback, const axis2_env_t *env)

Gets the complete status for the callback. This method is useful for polling (busy waiting). e.g.

          while(!AXIS2_CALLBACK_GET_COMPLETE(callback, env))
          {
             sleep(10);
          }
          // do whatever you need here 
      
Parameters:
callback pointer to callback struct
env pointer to environment struct
Returns:
AXIS2_TRUE if callback is complete, else AXIS2_FALSE

void*( * axis2_callback_ops::get_data)(const axis2_callback_t *callback)

Gets the callback data.

Parameters:
callback pointer to callback struct
Returns:
pointer to callback data

axiom_soap_envelope_t*( * axis2_callback_ops::get_envelope)(const axis2_callback_t *callback, const axis2_env_t *env)

Gets the resulting SOAP envelope.

Parameters:
callback pointer to callback struct
env pointer to environment struct
Returns:
result SOAP envelope if present, else NULL

int( * axis2_callback_ops::get_error)(const axis2_callback_t *callback, const axis2_env_t *env)

Gets error code representing the error.

Parameters:
callback pointer to callback struct
env pointer to environment struct
Returns:
error code representing the error

axis2_status_t( * axis2_callback_ops::invoke_on_complete)(axis2_callback_t *callback, const axis2_env_t *env, axis2_async_result_t *result)

This function is called once the asynchronous operation is successfully completed and the result is available.

Parameters:
callback pointer to callback struct
env pointer to environment struct
result pointer to async result
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_callback_ops::on_complete)(axis2_callback_t *callback, const axis2_env_t *env)

This function is called by invoke_on_complete. Users could provide this method so that they can define what to be done when the callback returns on completion.

Parameters:
callback pointer to callback struct
env pointer to environment struct
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_callback_ops::on_error)(axis2_callback_t *callback, const axis2_env_t *env, const int exception)

This function is called by report_error. Users could provide this method so that they can define what to be done when the callback returns an error.

Parameters:
callback pointer to callback struct
env pointer to environment struct
exception error code representing the error
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_callback_ops::report_error)(axis2_callback_t *callback, const axis2_env_t *env, const int exception)

This function is called once the asynchronous operation fails and the failure code returns.

Parameters:
callback pointer to callback struct
env pointer to environment struct
exception error code representing the error
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_callback_ops::set_complete)(axis2_callback_t *callback, const axis2_env_t *env, const axis2_bool_t complete)

Sets the complete status.

Parameters:
callback pointer to callback struct
env pointer to environment struct
complete bool value representing the status
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_callback_ops::set_data)(axis2_callback_t *callback, void *data)

Sets the callback data.

Parameters:
callback pointer to callback struct
data pointer to data
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_callback_ops::set_envelope)(axis2_callback_t *callback, const axis2_env_t *env, axiom_soap_envelope_t *envelope)

Sets the SOAP envelope.

Parameters:
callback pointer to callback struct
env pointer to environment struct
envelope pointer to SOAP envelope
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_callback_ops::set_error)(axis2_callback_t *callback, const axis2_env_t *env, const int error)

Sets the error code.

Parameters:
callback pointer to callback struct
env pointer to environment struct
error error code representing the error
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

void( * axis2_callback_ops::set_on_complete)(axis2_callback_t *callback, axis2_on_complete_func_ptr f)

Sets the on complete callback function.

Parameters:
callback pointer to callback struct
f on complete callback function pointer

void( * axis2_callback_ops::set_on_error)(axis2_callback_t *callback, axis2_on_error_func_ptr f)

Sets the on error callback function.

Parameters:
callback pointer to callback struct
f on error callback function pointer


The documentation for this struct was generated from the following file:
Generated on Tue Oct 3 20:48:18 2006 for Axis2/C by  doxygen 1.4.7