operation client
[client API]


Files

file  axis2_op_client.h

Classes

struct  axis2_op_client_ops
struct  axis2_op_client

Defines

#define AXIS2_OP_CLIENT_SET_OPTIONS(op_client, env, options)   ((op_client)->ops->set_options(op_client, env, options))
#define AXIS2_OP_CLIENT_GET_OPTIONS(op_client, env)   ((op_client)->ops->get_options(op_client, env))
#define AXIS2_OP_CLIENT_ADD_MSG_CTX(op_client, env, msg_ctx)   ((op_client)->ops->add_msg_ctx(op_client, env, msg_ctx))
#define AXIS2_OP_CLIENT_ADD_OUT_MSG_CTX(op_client, env, msg_ctx)   ((op_client)->ops->add_out_msg_ctx(op_client, env, msg_ctx))
#define AXIS2_OP_CLIENT_GET_MSG_CTX(op_client, env, message_label)   ((op_client)->ops->get_msg_ctx(op_client, env, message_label))
#define AXIS2_OP_CLIENT_SET_CALLBACK(op_client, env, callback)   ((op_client)->ops->set_callback(op_client, env, callback))
#define AXIS2_OP_CLIENT_GET_CALLBACK(op_client, env)   ((op_client)->ops->get_callback(op_client, env))
#define AXIS2_OP_CLIENT_EXECUTE(op_client, env, block)   ((op_client)->ops->execute(op_client, env, block))
#define AXIS2_OP_CLIENT_RESET(op_client, env)   ((op_client)->ops->reset(op_client, env))
#define AXIS2_OP_CLIENT_COMPLETE(op_client, env, msg_ctx)   ((op_client)->ops->complete(op_client, env, msg_ctx))
#define AXIS2_OP_CLIENT_GET_OPERATION_CONTEXT(op_client, env)   ((op_client)->ops->get_operation_context(op_client, env))
#define AXIS2_OP_CLIENT_FREE(op_client, env)   ((op_client)->ops->free(op_client, env))
#define AXIS2_OP_CLIENT_SET_CALLBACK_RECV(op_client, env, callback_recv)   ((op_client)->ops->set_callback_recv(op_client, env, callback_recv))

Typedefs

typedef axis2_op_client_ops axis2_op_client_ops_t
typedef axis2_op_client axis2_op_client_t

Functions

AXIS2_EXTERN axis2_op_client_taxis2_op_client_create (const axis2_env_t *env, axis2_op_t *op, axis2_svc_ctx_t *svc_ctx, axis2_options_t *options)

Detailed Description

The operation client is meant to be used by advanced users to consume services. Operation client understands a specific Message Exchange Pattern (MEP) and hence the behavior is defined by the MEP. To consume services with an operation client, an operation (of type axis2_op_t) and a service context (of type axis2_svc_ctx_t) has to be provided along with options to be used. The execute() function can be used to send the request and get the response. The service client implementation uses the operation client and provides an easy to use API for consuming services. Hence the service client implementation is a very good example of how to use the operation client API.
See also:
axis2_svc_client

Define Documentation

#define AXIS2_OP_CLIENT_ADD_MSG_CTX ( op_client,
env,
msg_ctx   )     ((op_client)->ops->add_msg_ctx(op_client, env, msg_ctx))

Adds a message context.

See also:
axis2_op_client_ops::add_msg_ctx

#define AXIS2_OP_CLIENT_ADD_OUT_MSG_CTX ( op_client,
env,
msg_ctx   )     ((op_client)->ops->add_out_msg_ctx(op_client, env, msg_ctx))

Adds out message context.

See also:
axis2_op_client_ops::add_out_msg_ctx

#define AXIS2_OP_CLIENT_COMPLETE ( op_client,
env,
msg_ctx   )     ((op_client)->ops->complete(op_client, env, msg_ctx))

Completes operation client, closing open transports.

See also:
axis2_op_client_ops::complete

#define AXIS2_OP_CLIENT_EXECUTE ( op_client,
env,
block   )     ((op_client)->ops->execute(op_client, env, block))

Executes operation client.

See also:
axis2_op_client_ops::execute

#define AXIS2_OP_CLIENT_FREE ( op_client,
env   )     ((op_client)->ops->free(op_client, env))

Frees the operation client.

See also:
axis2_op_client_ops::free

#define AXIS2_OP_CLIENT_GET_CALLBACK ( op_client,
env   )     ((op_client)->ops->get_callback(op_client, env))

gets operation callback.

See also:
axis2_op_client_ops::get_callback

#define AXIS2_OP_CLIENT_GET_MSG_CTX ( op_client,
env,
message_label   )     ((op_client)->ops->get_msg_ctx(op_client, env, message_label))

Gets the message context corresponding to given label.

See also:
axis2_op_client_ops::get_msg_ctx

#define AXIS2_OP_CLIENT_GET_OPERATION_CONTEXT ( op_client,
env   )     ((op_client)->ops->get_operation_context(op_client, env))

Gets the operation context.

See also:
axis2_op_client_ops::get_operation_context

#define AXIS2_OP_CLIENT_GET_OPTIONS ( op_client,
env   )     ((op_client)->ops->get_options(op_client, env))

Gets the options used by operation client.

See also:
axis2_op_client_ops::get_options

#define AXIS2_OP_CLIENT_RESET ( op_client,
env   )     ((op_client)->ops->reset(op_client, env))

Resets operation client.

See also:
axis2_op_client_ops::reset

#define AXIS2_OP_CLIENT_SET_CALLBACK ( op_client,
env,
callback   )     ((op_client)->ops->set_callback(op_client, env, callback))

Sets operation client callback.

See also:
axis2_op_client_ops::set_callback

#define AXIS2_OP_CLIENT_SET_CALLBACK_RECV ( op_client,
env,
callback_recv   )     ((op_client)->ops->set_callback_recv(op_client, env, callback_recv))

Sets the callback receiver.

See also:
axis2_op_client_ops::set_callback_recv

#define AXIS2_OP_CLIENT_SET_OPTIONS ( op_client,
env,
options   )     ((op_client)->ops->set_options(op_client, env, options))

Sets the options to be used by operation client.

See also:
axis2_op_client_ops::set_options


Typedef Documentation

typedef struct axis2_op_client_ops axis2_op_client_ops_t

Type name for struct axis2_op_client_ops

typedef struct axis2_op_client axis2_op_client_t

Type name for struct axis2_op_client


Function Documentation

AXIS2_EXTERN axis2_op_client_t* axis2_op_client_create ( const axis2_env_t env,
axis2_op_t op,
axis2_svc_ctx_t svc_ctx,
axis2_options_t options 
)

Creates an operation client struct for the specified operation, service context and given options.

Parameters:
env pointer to environment struct
op pointer to operation struct corresponding to the operation to to be executed. Newly created client assumes ownership of the operation.
svc_ctx pointer to service context struct representing the service to be consumed. Newly created client assumes ownership of the service context.
options options to be used by operation client. Newly created client assumes ownership of the options context.
Returns:
a pointer to newly created operation client struct, or NULL on error with error code set in environment's error


Generated on Wed Dec 20 20:35:02 2006 for Axis2/C by  doxygen 1.5.1