axis2_transport_in_desc_ops Struct Reference
[transport in description]

#include <axis2_transport_in_desc.h>

List of all members.

Public Attributes

axis2_status_t(* free )(axis2_transport_in_desc_t *transport_in_desc, const axis2_env_t *env)
axis2_status_t(* free_void_arg )(void *transport_in, const axis2_env_t *env)
const axis2_qname_t *(* get_qname )(const axis2_transport_in_desc_t *transport_in, const axis2_env_t *env)
axis2_status_t(* set_qname )(struct axis2_transport_in_desc *transport_in, const axis2_env_t *env, const axis2_qname_t *qname)
axis2_flow *(* get_in_flow )(const axis2_transport_in_desc_t *transport_in, const axis2_env_t *env)
axis2_status_t(* set_in_flow )(struct axis2_transport_in_desc *transport_in, const axis2_env_t *env, struct axis2_flow *in_flow)
axis2_flow *(* get_fault_in_flow )(const axis2_transport_in_desc_t *transport_in, const axis2_env_t *env)
axis2_status_t(* set_fault_in_flow )(struct axis2_transport_in_desc *transport_in, const axis2_env_t *env, struct axis2_flow *fault_in_flow)
axis2_transport_receiver *(* get_recv )(const axis2_transport_in_desc_t *transport_in, const axis2_env_t *env)
axis2_status_t(* set_recv )(struct axis2_transport_in_desc *transport_in, const axis2_env_t *env, struct axis2_transport_receiver *recv)
axis2_phase *(* get_in_phase )(const axis2_transport_in_desc_t *transport_in, const axis2_env_t *env)
axis2_status_t(* set_in_phase )(struct axis2_transport_in_desc *transport_in, const axis2_env_t *env, struct axis2_phase *in_phase)
axis2_phase *(* get_fault_phase )(const axis2_transport_in_desc_t *transport_in, const axis2_env_t *env)
axis2_status_t(* set_fault_phase )(struct axis2_transport_in_desc *transport_in, const axis2_env_t *env, struct axis2_phase *fault_phase)
axis2_status_t(* add_param )(axis2_transport_in_desc_t *transport_in_desc, const axis2_env_t *env, axis2_param_t *param)
axis2_param_t *(* get_param )(const axis2_transport_in_desc_t *transport_in_desc, const axis2_env_t *env, const axis2_char_t *param_name)
axis2_bool_t(* is_param_locked )(axis2_transport_in_desc_t *transport_in_desc, const axis2_env_t *env, const axis2_char_t *param_name)


Detailed Description

transport in description ops struct. Encapsulator struct for ops of axis2_transport_in_desc.


Member Data Documentation

axis2_status_t( * axis2_transport_in_desc_ops::add_param)(axis2_transport_in_desc_t *transport_in_desc, const axis2_env_t *env, axis2_param_t *param)

Adds given parameter.

Parameters:
transport_in_desc pointer to transport in description struct
env pointer to environment struct
param pointer to parameter, transport in description assumes ownership of parameter
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_transport_in_desc_ops::free)(axis2_transport_in_desc_t *transport_in_desc, const axis2_env_t *env)

Frees transport in description.

Parameters:
transport_in_desc pointer to transport in description struct
env pointer to environment struct
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_transport_in_desc_ops::free_void_arg)(void *transport_in, const axis2_env_t *env)

Frees transport in description given as a void parameter.

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

struct axis2_flow*( * axis2_transport_in_desc_ops::get_fault_in_flow)(const axis2_transport_in_desc_t *transport_in, const axis2_env_t *env)

Gets fault in flow. Fault in flow represents the list of phases invoked along the receive path if a fault happens.

Parameters:
transport_in pointer to transport in description struct
env pointer to environment struct
Returns:
pointer to flow representing fault in flow, returns a reference, not a cloned copy

struct axis2_phase*( * axis2_transport_in_desc_ops::get_fault_phase)(const axis2_transport_in_desc_t *transport_in, const axis2_env_t *env)

Gets the transport fault phase associated with transport in description.

Parameters:
transport_in pointer to transport in description struct
env pointer to environment struct
Returns:
pointer to phase representing fault phase

struct axis2_flow*( * axis2_transport_in_desc_ops::get_in_flow)(const axis2_transport_in_desc_t *transport_in, const axis2_env_t *env)

Gets in flow. In flow represents the list of phases invoked along the receive path.

Parameters:
transport_in pointer to transport in description struct
env pointer to environment struct
Returns:
pointer to flow representing in flow, returns a reference, not a cloned copy

struct axis2_phase*( * axis2_transport_in_desc_ops::get_in_phase)(const axis2_transport_in_desc_t *transport_in, const axis2_env_t *env)

Gets the transport in phase associated with transport in description.

Parameters:
transport_in pointer to transport in description struct
env pointer to environment struct
Returns:
transport in phase, returns a reference, not a cloned copy

axis2_param_t*( * axis2_transport_in_desc_ops::get_param)(const axis2_transport_in_desc_t *transport_in_desc, const axis2_env_t *env, const axis2_char_t *param_name)

Gets named parameter.

Parameters:
transport_in_desc pointer to transport in description struct
env pointer to environment struct
param_name parameter name string
Returns:
pointer to named parameter if it exists, else NULL. Returns a reference, not a cloned copy

const axis2_qname_t*( * axis2_transport_in_desc_ops::get_qname)(const axis2_transport_in_desc_t *transport_in, const axis2_env_t *env)

Gets QName.

Parameters:
transport_in pointer to transport in description struct
env pointer to environment struct
Returns:
pointer to QName

struct axis2_transport_receiver*( * axis2_transport_in_desc_ops::get_recv)(const axis2_transport_in_desc_t *transport_in, const axis2_env_t *env)

Gets transport receiver associated with the transport in description.

Parameters:
transport_in pointer to transport in description struct
env pointer to environment struct
Returns:
pointer to transport receiver, returns a reference, not a cloned copy

axis2_bool_t( * axis2_transport_in_desc_ops::is_param_locked)(axis2_transport_in_desc_t *transport_in_desc, const axis2_env_t *env, const axis2_char_t *param_name)

Checks if the named parameter is locked.

Parameters:
transport_in_desc pointer to transport in description struct
env pointer to environment struct
param_name parameter name string
Returns:
AXIS2_TRUE if named parameter is locked, else AXIS2_FALSE

axis2_status_t( * axis2_transport_in_desc_ops::set_fault_in_flow)(struct axis2_transport_in_desc *transport_in, const axis2_env_t *env, struct axis2_flow *fault_in_flow)

Sets fault in flow. Fault in flow represents the list of phases invoked along the receive path if a fault happens.

Parameters:
transport_in pointer to transport in description struct
env pointer to environment struct
fault_in_flow pointer to flow representing fault in flow, transport in description assumes the ownership of the flow
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_transport_in_desc_ops::set_fault_phase)(struct axis2_transport_in_desc *transport_in, const axis2_env_t *env, struct axis2_phase *fault_phase)

Sets the transport fault phase associated with transport in description.

Parameters:
transport_in pointer to transport in description struct
env pointer to environment struct
fault_phase pointer to fault phase
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_transport_in_desc_ops::set_in_flow)(struct axis2_transport_in_desc *transport_in, const axis2_env_t *env, struct axis2_flow *in_flow)

Sets in flow. In flow represents the list of phases invoked along the receive path.

Parameters:
transport_in pointer to transport in description struct
env pointer to environment struct
in_flow pointer to in flow representing in flow, transport in description assumes ownership of the flow
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_transport_in_desc_ops::set_in_phase)(struct axis2_transport_in_desc *transport_in, const axis2_env_t *env, struct axis2_phase *in_phase)

Sets the transport in phase associated with transport in description.

Parameters:
transport_in pointer to transport in description struct
env pointer to environment struct
in_phase pointer to phase representing transport in phase, transport in description assumes ownership of phase
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_transport_in_desc_ops::set_qname)(struct axis2_transport_in_desc *transport_in, const axis2_env_t *env, const axis2_qname_t *qname)

Sets QName.

Parameters:
transport_in pointer to transport in description struct
env pointer to environment struct
qname pointer to QName, this method creates a clone of QName
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_transport_in_desc_ops::set_recv)(struct axis2_transport_in_desc *transport_in, const axis2_env_t *env, struct axis2_transport_receiver *recv)

Sets transport receiver associated with the transport in description.

Parameters:
transport_in pointer to transport in description struct
env pointer to environment struct
recv pointer to transport receiver, transport in description assumes ownership of the receiver
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