Main Page | Modules | Class List | Directories | File List | Class Members | File Members | Examples

axis2_op_client_ops Struct Reference
[Operation Client]

Operation Client ops struct Encapsulator struct for ops of axis2_op_client. More...

#include <axis2_op_client.h>

List of all members.

Public Attributes

axis2_status_t(* set_options )(struct axis2_op_client *op_client, const axis2_env_t *env, axis2_options_t *options)
axis2_options_t *(* get_options )(struct axis2_op_client *op_client, const axis2_env_t *env)
axis2_status_t(* add_msg_ctx )(struct axis2_op_client *op_client, const axis2_env_t *env, axis2_msg_ctx_t *mc)
axis2_msg_ctx_t *(* get_msg_ctx )(struct axis2_op_client *op_client, const axis2_env_t *env, const axis2_char_t *message_label)
axis2_status_t(* set_callback )(struct axis2_op_client *op_client, const axis2_env_t *env, axis2_callback_t *callback)
axis2_status_t(* execute )(struct axis2_op_client *op_client, const axis2_env_t *env, axis2_bool_t block)
axis2_status_t(* reset )(struct axis2_op_client *op_client, const axis2_env_t *env)
axis2_status_t(* compelete )(struct axis2_op_client *op_client, const axis2_env_t *env, axis2_msg_ctx_t *mc)
axis2_op_ctx_t *(* get_operation_context )(struct axis2_op_client *op_client)
axis2_status_t(* set_callback_recv )(struct axis2_op_client *op_client, const axis2_env_t *env, struct axis2_callback_recv *callback_recv)
axis2_status_t(* free )(struct axis2_op_client *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)(struct axis2_op_client *op_client, const axis2_env_t *env, axis2_msg_ctx_t *mc)
 

Add a message context to the client for processing. This method must not process the message - it only records it in the operation client. Processing only occurs when execute() is called.

Parameters:
mc the message context

axis2_status_t( * axis2_op_client_ops::compelete)(struct axis2_op_client *op_client, const axis2_env_t *env, axis2_msg_ctx_t *mc)
 

To close the tranport if necessary , can call this method. The most usage of thie method when clinet use two tarnport for sending and receiving , there we need to remove entry from waitings calls in the transport listener queue Note : DO NOT call this method if you are not using two transport send and receive

Parameters:
mc : axis2_msg_ctx_t# which have all the trnport information

axis2_status_t( * axis2_op_client_ops::execute)(struct axis2_op_client *op_client, const axis2_env_t *env, 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, then if the Out message has been set, then executing the client asks it to send the message and get the In message, possibly using a different thread.

Parameters:
block Indicates whether execution should block or return ASAP. What block means is of course a function of the specific operation client.

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

Return a message from the client - will return null if the requested message is not available.

Parameters:
message_label the message label of the desired message context
Returns:
the desired message context or null if its not available.

axis2_op_ctx_t*( * axis2_op_client_ops::get_operation_context)(struct axis2_op_client *op_client)
 

To get the operation context of the operation cleint

Returns:
Operation Context

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

Return the options used by this client. If you want to set a single option, then the right way is to do get_options() and set specific options.

Returns:
the options, which will never be null.

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

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

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

Set the callback to be executed when a message comes into the MEP and the operation client is executed. This is the way the operation client provides notification that a message has been received by it. Exactly when its executed and under what conditions is a function of the specific operation client.

Parameters:
callback the callback to be used when the client decides its time to use it

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

Sets the options that should be used for this particular client. This resets the entire set of options to use the new options - so you'd lose any option cascading that may have been set up.

Parameters:
options the options


The documentation for this struct was generated from the following file:
Generated on Fri Jun 16 18:02:41 2006 for Axis2/C by  doxygen 1.4.2