axis2_op_client_ops Struct Reference
[operation client]

#include <axis2_op_client.h>

List of all members.

Public Attributes

axis2_status_t(* set_options )(axis2_op_client_t *op_client, const axis2_env_t *env, const axis2_options_t *options)
const axis2_options_t *(* get_options )(const axis2_op_client_t *op_client, const axis2_env_t *env)
axis2_status_t(* add_msg_ctx )(axis2_op_client_t *op_client, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx)
axis2_status_t(* add_out_msg_ctx )(axis2_op_client_t *op_client, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx)
const axis2_msg_ctx_t *(* get_msg_ctx )(const axis2_op_client_t *op_client, const axis2_env_t *env, const axis2_char_t *message_label)
axis2_status_t(* set_callback )(axis2_op_client_t *op_client, const axis2_env_t *env, axis2_callback_t *callback)
axis2_status_t(* execute )(axis2_op_client_t *op_client, const axis2_env_t *env, const axis2_bool_t block)
axis2_status_t(* reset )(axis2_op_client_t *op_client, const axis2_env_t *env)
axis2_status_t(* complete )(axis2_op_client_t *op_client, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx)
axis2_op_ctx_t *(* get_operation_context )(const axis2_op_client_t *op_client, const axis2_env_t *env)
axis2_status_t(* set_callback_recv )(axis2_op_client_t *op_client, const axis2_env_t *env, struct axis2_callback_recv *callback_recv)
axis2_status_t(* free )(axis2_op_client_t *op_client, const axis2_env_t *env)


Detailed Description

operation client ops struct. Encapsulator struct for ops of axis2_op_client.


Member Data Documentation

axis2_status_t( * axis2_op_client_ops::add_msg_ctx)(axis2_op_client_t *op_client, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx)

Adds a message context to the client for processing.

Parameters:
op_client pointer to operation client struct
env pointer to environment struct
msg_ctx message context to be added. operation client takes over the ownership of the message context struct.
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_op_client_ops::add_out_msg_ctx)(axis2_op_client_t *op_client, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx)

Adds out message context to the client for processing.

Parameters:
op_client pointer to operation client struct
env pointer to environment struct
msg_ctx message context to be added. operation client takes over the ownership of the message context struct.
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_op_client_ops::complete)(axis2_op_client_t *op_client, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx)

Completes the execution by closing the transports if necessary. This method is useful when client uses two transports for sending and receiving.

Parameters:
op_client pointer to operation client struct
env pointer to environment struct
msg_ctx message context which contains the transport information
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_op_client_ops::execute)(axis2_op_client_t *op_client, const axis2_env_t *env, const axis2_bool_t block)

Execute the MEP. What this does depends on the specific operation client. The basic idea is to have the operation client execute and do something with the messages that have been added to it so far. For example, if its an Out-In MEP, and if the Out message has been set, then executing the client asks it to send the out message and get the in message

Parameters:
op_client pointer to operation client
env pointer to environment struct
block indicates whether execution should block or return ASAP
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_op_client_ops::free)(axis2_op_client_t *op_client, const axis2_env_t *env)

Frees the operation client

Parameters:
op_client pointer to operation client struct
env pointer to environment struct
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

const axis2_msg_ctx_t*( * axis2_op_client_ops::get_msg_ctx)(const axis2_op_client_t *op_client, const axis2_env_t *env, const axis2_char_t *message_label)

Gets a message corresponding to the given label.

Parameters:
op_client pointer to operation client struct
env pointer to environment struct
message_label the message label of the desired message context
Returns:
the desired message context or NULL if its not available. Returns a reference, not a cloned copy.

axis2_op_ctx_t*( * axis2_op_client_ops::get_operation_context)(const axis2_op_client_t *op_client, const axis2_env_t *env)

Gets the operation context of the operation client.

Parameters:
op_client pointer to operation client struct
env pointer to environment struct
Returns:
operation context related to operation client

const axis2_options_t*( * axis2_op_client_ops::get_options)(const axis2_op_client_t *op_client, const axis2_env_t *env)

Gets options used by operation client.

Parameters:
op_client pointer to operation client struct
env pointer to environment struct
Returns:
a pointer to the options struct if options set, else NULL. Returns a reference, not a cloned copy.

axis2_status_t( * axis2_op_client_ops::reset)(axis2_op_client_t *op_client, const axis2_env_t *env)

Resets the operation client to a clean status after the MEP has completed. This is how you can reuse an operation client. Note that this does not reset the options; only the internal state so the client can be used again.

Parameters:
op_client pointer to operation client
env pointer to environment struct
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_op_client_ops::set_callback)(axis2_op_client_t *op_client, const axis2_env_t *env, axis2_callback_t *callback)

Sets the callback to be executed when a response message is received.

Parameters:
op_client pointer to operation client struct
env pointer to environment struct
callback the callback to be used. operation client takes over the ownership of the message context struct.
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_op_client_ops::set_callback_recv)(axis2_op_client_t *op_client, const axis2_env_t *env, struct axis2_callback_recv *callback_recv)

Sets callback receiver.

Parameters:
op_client pointer to operation client struct
env pointer to environment struct
callback_recv pointer to callback receiver struct. operation client assumes ownership of the callback struct.
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_op_client_ops::set_options)(axis2_op_client_t *op_client, const axis2_env_t *env, const axis2_options_t *options)

Sets the options that is to be used by this operation client.

Parameters:
op_client pointer to operation client struct
env pointer to environment struct
options pointer to options struct to be set
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE


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