transport out description
[description]


Files

file  axis2_transport_out_desc.h

Classes

struct  axis2_transport_out_desc_ops
struct  axis2_transport_out_desc

Defines

#define AXIS2_TRANSPORT_OUT_DESC_FREE(transport_out_desc, env)   ((transport_out_desc)->ops->free (transport_out_desc, env))
#define AXIS2_TRANSPORT_OUT_DESC_GET_QNAME(transport_out_desc, env)   ((transport_out_desc)->ops->get_qname (transport_out_desc, env))
#define AXIS2_TRANSPORT_OUT_DESC_SET_QNAME(transport_out_desc, env, qname)   ((transport_out_desc)->ops->set_qname (transport_out_desc, env, qname))
#define AXIS2_TRANSPORT_OUT_DESC_GET_OUT_FLOW(transport_out_desc, env)   ((transport_out_desc)->ops->get_out_flow (transport_out_desc, env))
#define AXIS2_TRANSPORT_OUT_DESC_SET_OUT_FLOW(transport_out_desc, env, out_flow)   ((transport_out_desc)->ops->set_out_flow (transport_out_desc, env, out_flow))
#define AXIS2_TRANSPORT_OUT_DESC_GET_FAULT_OUT_FLOW(transport_out_desc, env)   ((transport_out_desc)->ops->get_fault_out_flow (transport_out_desc, env))
#define AXIS2_TRANSPORT_OUT_DESC_SET_FAULT_OUT_FLOW(transport_out_desc, env, fault_out_flow)   ((transport_out_desc)->ops->set_fault_out_flow (transport_out_desc, env, fault_out_flow))
#define AXIS2_TRANSPORT_OUT_DESC_GET_SENDER(transport_out_desc, env)   ((transport_out_desc)->ops->get_sender (transport_out_desc, env))
#define AXIS2_TRANSPORT_OUT_DESC_SET_SENDER(transport_out_desc, env, sender)   ((transport_out_desc)->ops->set_sender (transport_out_desc, env, sender))
#define AXIS2_TRANSPORT_OUT_DESC_GET_OUT_PHASE(transport_out_desc, env)   ((transport_out_desc)->ops->get_out_phase (transport_out_desc, env))
#define AXIS2_TRANSPORT_OUT_DESC_SET_OUT_PHASE(transport_out_desc, env, out_phase)   ((transport_out_desc)->ops->set_out_phase (transport_out_desc, env, out_phase))
#define AXIS2_TRANSPORT_OUT_DESC_GET_FAULT_PHASE(transport_out_desc, env)   ((transport_out_desc)->ops->get_fault_phase (transport_out_desc, env))
#define AXIS2_TRANSPORT_OUT_DESC_SET_FAULT_PHASE(transport_out_desc, env, fault_phase)   ((transport_out_desc)->ops->set_fault_phase (transport_out_desc, env, fault_phase))
#define AXIS2_TRANSPORT_OUT_DESC_ADD_PARAM(transport_out_desc, env, param)   ((transport_out_desc)->ops->add_param (transport_out_desc, env, param))
#define AXIS2_TRANSPORT_OUT_DESC_GET_PARAM(transport_out_desc, env, param_name)   ((transport_out_desc)->ops->get_param (transport_out_desc, env, param_name))
#define AXIS2_TRANSPORT_OUT_DESC_IS_PARAM_LOCKED(transport_out_desc, env, param_name)   ((transport_out_desc)->ops->is_param_locked (transport_out_desc, env, param_name))

Typedefs

typedef axis2_transport_out_desc axis2_transport_out_desc_t
typedef axis2_transport_out_desc_ops axis2_transport_out_desc_ops_t

Functions

AXIS2_EXTERN axis2_transport_out_desc_taxis2_transport_out_desc_create_with_qname (const axis2_env_t *env, const axis2_qname_t *qname)
axis2_status_t axis2_transport_out_desc_free_void_arg (void *transport_out, const axis2_env_t *env)

Detailed Description

transport out description represents a transport sender configured in Axis2 configuration. There can be multiple transport senders configured in axis2.xml file and each of them will be represented with a transport out description instance. deployment engine takes care of creating and instantiating transport out descriptions. transport out description encapsulates flows related to the transport out and also holds a reference to related transport sender.

Define Documentation

#define AXIS2_TRANSPORT_OUT_DESC_ADD_PARAM ( transport_out_desc,
env,
param   )     ((transport_out_desc)->ops->add_param (transport_out_desc, env, param))

Adds given parameter.

See also:
axis2_transport_out_desc_ops::add_param

#define AXIS2_TRANSPORT_OUT_DESC_FREE ( transport_out_desc,
env   )     ((transport_out_desc)->ops->free (transport_out_desc, env))

Frees transport out description.

See also:
axis2_transport_out_desc_ops::free

#define AXIS2_TRANSPORT_OUT_DESC_GET_FAULT_OUT_FLOW ( transport_out_desc,
env   )     ((transport_out_desc)->ops->get_fault_out_flow (transport_out_desc, env))

Gets fault out flow.

See also:
axis2_transport_out_desc_ops::get_fault_out_flow

#define AXIS2_TRANSPORT_OUT_DESC_GET_FAULT_PHASE ( transport_out_desc,
env   )     ((transport_out_desc)->ops->get_fault_phase (transport_out_desc, env))

Gets fault phase.

See also:
axis2_transport_out_desc_ops::get_fault_phase

#define AXIS2_TRANSPORT_OUT_DESC_GET_OUT_FLOW ( transport_out_desc,
env   )     ((transport_out_desc)->ops->get_out_flow (transport_out_desc, env))

Gets out flow.

See also:
axis2_transport_out_desc_ops::get_out_flow

#define AXIS2_TRANSPORT_OUT_DESC_GET_OUT_PHASE ( transport_out_desc,
env   )     ((transport_out_desc)->ops->get_out_phase (transport_out_desc, env))

Gets out phase.

See also:
axis2_transport_out_desc_ops::get_out_phase

#define AXIS2_TRANSPORT_OUT_DESC_GET_PARAM ( transport_out_desc,
env,
param_name   )     ((transport_out_desc)->ops->get_param (transport_out_desc, env, param_name))

Gets named parameter.

See also:
axis2_transport_out_desc_ops::get_param

#define AXIS2_TRANSPORT_OUT_DESC_GET_QNAME ( transport_out_desc,
env   )     ((transport_out_desc)->ops->get_qname (transport_out_desc, env))

Gets QName.

See also:
axis2_transport_out_desc_ops::get_qname

#define AXIS2_TRANSPORT_OUT_DESC_GET_SENDER ( transport_out_desc,
env   )     ((transport_out_desc)->ops->get_sender (transport_out_desc, env))

Gets transport sender.

See also:
axis2_transport_out_desc_ops::get_sender

#define AXIS2_TRANSPORT_OUT_DESC_IS_PARAM_LOCKED ( transport_out_desc,
env,
param_name   )     ((transport_out_desc)->ops->is_param_locked (transport_out_desc, env, param_name))

Checks if the named parameter locked.

See also:
axis2_transport_out_desc_ops::is_param_locked

#define AXIS2_TRANSPORT_OUT_DESC_SET_FAULT_OUT_FLOW ( transport_out_desc,
env,
fault_out_flow   )     ((transport_out_desc)->ops->set_fault_out_flow (transport_out_desc, env, fault_out_flow))

Sets fault out flow.

See also:
axis2_transport_out_desc_ops::set_fault_out_flow

#define AXIS2_TRANSPORT_OUT_DESC_SET_FAULT_PHASE ( transport_out_desc,
env,
fault_phase   )     ((transport_out_desc)->ops->set_fault_phase (transport_out_desc, env, fault_phase))

Sets fault phase.

See also:
axis2_transport_out_desc_ops::set_fault_phase

#define AXIS2_TRANSPORT_OUT_DESC_SET_OUT_FLOW ( transport_out_desc,
env,
out_flow   )     ((transport_out_desc)->ops->set_out_flow (transport_out_desc, env, out_flow))

Sets out flow.

See also:
axis2_transport_out_desc_ops::set_out_flow

#define AXIS2_TRANSPORT_OUT_DESC_SET_OUT_PHASE ( transport_out_desc,
env,
out_phase   )     ((transport_out_desc)->ops->set_out_phase (transport_out_desc, env, out_phase))

Sets out phase.

See also:
axis2_transport_out_desc_ops::set_out_phase

#define AXIS2_TRANSPORT_OUT_DESC_SET_QNAME ( transport_out_desc,
env,
qname   )     ((transport_out_desc)->ops->set_qname (transport_out_desc, env, qname))

Sets QName.

See also:
axis2_transport_out_desc_ops::set_qname

#define AXIS2_TRANSPORT_OUT_DESC_SET_SENDER ( transport_out_desc,
env,
sender   )     ((transport_out_desc)->ops->set_sender (transport_out_desc, env, sender))

Sets transport sender.

See also:
axis2_transport_out_desc_ops::set_sender


Typedef Documentation

typedef struct axis2_transport_out_desc_ops axis2_transport_out_desc_ops_t

Type name for struct axis2_transport_out_desc_ops

typedef struct axis2_transport_out_desc axis2_transport_out_desc_t

Type name for struct axis2_transport_out_desc


Function Documentation

AXIS2_EXTERN axis2_transport_out_desc_t* axis2_transport_out_desc_create_with_qname ( const axis2_env_t env,
const axis2_qname_t *  qname 
)

Creates transport out description with given QName.

Parameters:
env pointer to environment struct
qname pointer to QName, newly created transport out description creates a clone of this
Returns:
pointer to newly created transport out

axis2_status_t axis2_transport_out_desc_free_void_arg ( void *  transport_out,
const axis2_env_t env 
)

Frees transport out description given as a void pointer.

Parameters:
transport_out_dec pointer to transport out description as a void pointer
env pointer to environment struct
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE


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