stub
[client API]


Files

file  axis2_stub.h

Classes

struct  axis2_stub_ops
struct  axis2_stub

Defines

#define AXIOM_SOAP_11   0
#define AXIOM_SOAP_12   1
#define AXIS2_STUB_FREE(stub, env)   ((stub)->ops->free (stub, env))
#define AXIS2_STUB_SET_ENDPOINT_REF(stub, env, endpoint_ref)   ((stub)->ops->set_endpoint_ref (stub, env, endpoint_ref))
#define AXIS2_STUB_SET_ENDPOINT_URI(stub, env, endpoint_uri)   ((stub)->ops->set_endpoint_uri (stub, env, endpoint_uri))
#define AXIS2_STUB_SET_USE_SEPERATE_LISTENER(stub, env, use_separate_listener)   ((stub)->ops->set_use_separate_listener (stub, env, use_separate_listener))
#define AXIS2_STUB_ENGAGE_MODULE(stub, env, module_name)   ((stub)->ops->engage_module (stub, env, module_name))
#define AXIS2_STUB_SET_SOAP_VERSION(stub, env, soap_version)   ((stub)->ops->set_soap_version (stub, env, soap_version))
#define AXIS2_STUB_GET_SVC_CTX_ID(stub, env)   ((stub)->ops->get_svc_ctx_id (stub, env))
#define AXIS2_STUB_GET_SVC_CLIENT(stub, env)   ((stub)->ops->get_svc_client(stub, env))
#define AXIS2_STUB_GET_OPTIONS(stub, env)   ((stub)->ops->get_options(stub, env))

Typedefs

typedef axis2_stub_ops axis2_stub_ops_t
typedef axis2_stub axis2_stub_t

Functions

AXIS2_EXTERN axis2_stub_taxis2_stub_create_with_endpoint_ref_and_client_home (const axis2_env_t *env, axis2_endpoint_ref_t *endpoint_ref, const axis2_char_t *client_home)
AXIS2_EXTERN axis2_stub_taxis2_stub_create_with_endpoint_uri_and_client_home (const axis2_env_t *env, const axis2_char_t *endpoint_uri, const axis2_char_t *client_home)

Detailed Description

stub is a wrapper API for service client that helps users to use client API easily.
See also:
axis2_svc_client

Define Documentation

#define AXIOM_SOAP_11   0

Constant value representing SOAP version 1.1

#define AXIOM_SOAP_12   1

Constant value representing SOAP version 1.2

#define AXIS2_STUB_ENGAGE_MODULE ( stub,
env,
module_name   )     ((stub)->ops->engage_module (stub, env, module_name))

Engages the module.

See also:
axis2_stub_ops::engage_module

#define AXIS2_STUB_FREE ( stub,
env   )     ((stub)->ops->free (stub, env))

Frees the axis2 stub.

See also:
axis2_stub_ops::free

#define AXIS2_STUB_GET_OPTIONS ( stub,
env   )     ((stub)->ops->get_options(stub, env))

Gets the options used by service client wrapped by this stub.

See also:
axis2_stub_ops::get_options

#define AXIS2_STUB_GET_SVC_CLIENT ( stub,
env   )     ((stub)->ops->get_svc_client(stub, env))

Gets the service client that this stub wraps.

See also:
axis2_stub_ops::get_svc_client

#define AXIS2_STUB_GET_SVC_CTX_ID ( stub,
env   )     ((stub)->ops->get_svc_ctx_id (stub, env))

Gets the service context id.

See also:
axis2_stub_ops::get_svc_ctx_id

#define AXIS2_STUB_SET_ENDPOINT_REF ( stub,
env,
endpoint_ref   )     ((stub)->ops->set_endpoint_ref (stub, env, endpoint_ref))

Sets the endpoint reference.

See also:
axis2_stub_ops::set_endpoint_ref

#define AXIS2_STUB_SET_ENDPOINT_URI ( stub,
env,
endpoint_uri   )     ((stub)->ops->set_endpoint_uri (stub, env, endpoint_uri))

Sets the endpoint uri.

See also:
axis2_stub_ops::set_endpoint_uri

#define AXIS2_STUB_SET_SOAP_VERSION ( stub,
env,
soap_version   )     ((stub)->ops->set_soap_version (stub, env, soap_version))

Sets the SOAP version.

See also:
axis2_stub_ops::set_soap_version

#define AXIS2_STUB_SET_USE_SEPERATE_LISTENER ( stub,
env,
use_separate_listener   )     ((stub)->ops->set_use_separate_listener (stub, env, use_separate_listener))

Sets bool value indicating whether to use a separate listener.

See also:
axis2_stub_ops::set_use_separate_listener


Typedef Documentation

typedef struct axis2_stub_ops axis2_stub_ops_t

Type name for struct axis2_stub_ops

typedef struct axis2_stub axis2_stub_t

Type name for struct axis2_stub


Function Documentation

AXIS2_EXTERN axis2_stub_t* axis2_stub_create_with_endpoint_ref_and_client_home ( const axis2_env_t env,
axis2_endpoint_ref_t endpoint_ref,
const axis2_char_t *  client_home 
)

Creates a stub instance.

Parameters:
env pointer to environment struct
endpoint_ref pointer to endpoint reference struct representing the stub endpoint. Newly created stub assumes ownership of the endpoint
client_home name of the directory that contains the Axis2/C repository
Returns:
pointer to newly created axis2_stub struct

AXIS2_EXTERN axis2_stub_t* axis2_stub_create_with_endpoint_uri_and_client_home ( const axis2_env_t env,
const axis2_char_t *  endpoint_uri,
const axis2_char_t *  client_home 
)

Creates a stub instance.

Parameters:
env pointer to environment struct
endpoint_uri string representing the endpoint reference
client_home name of the directory that contains the Axis2/C repository
Returns:
pointer to newly created axis2_stub struct


Generated on Tue Oct 3 20:48:10 2006 for Axis2/C by  doxygen 1.4.7