IT_Bus::ClientOperation Class Reference

#include <it_bus/operation.h>

Inheritance diagram for IT_Bus::ClientOperation:

List of all members.

---

Detailed Description

Class representing an operation within a client application.

Client code may use an instance of the client proxy base to create a ClientOperation instance for a specific operation. This allows construction of an operation call without using a proxy generated from a WSDL file. Use the client operation object to invoke the operation.

 ClientProxyBase client(wsdl_url, service_name, port_name);
 // The IT_AutoPtr<ClientOperation> class provides automatic
 // memory management.
 IT_AutoPtr<ClientOperation>
   operation(client.create_operation(operation_name));
 

An instance of the ClientOperation is passed as the parameter to a client request interceptor intercept_invoke() method. Use the ClientOperation instance to obtain a pointer to the context container, from which application code may access built-in or user-defined contexts. The ClientOperation instance may also be used to access the input and output messages and their corresponding parts.

Definition at line 148 of file operation.h.

Public Member Functions
virtual	~ClientOperation ()
	Destructor.
virtual const IT_WSDL::WSDLOperation &	get_wsdl_operation () const
	Returns a reference to the object that corresponds to the in-memory representation of the current operation.
virtual const String &	get_name () const
	Returns the name of the operation.
virtual WritableMessage &	get_input_message ()=0
	Return the input message encapsulated within this client operation object.
virtual ReadableMessage &	get_output_message ()=0
	Return the output message encapsulated within this client operation object.
virtual ContextContainer *	request_contexts ()=0
	Returns a pointer to the IT_Bus::ContextContainer that holds request contexts.
virtual ContextContainer *	reply_contexts ()=0
	Returns a pointer to the IT_Bus::ContextContainer that holds reply contexts.
virtual void	invoke () throw ((Exception))
	Call the operation represented by this client operation object.
virtual ClientOperationPassThrough *	get_client_pass_through ()=0
	Get access to the Message Buffers so the user can replace then if supported.

---

Member Function Documentation

virtual ClientOperationPassThrough* IT_Bus::ClientOperation::get_client_pass_through (   )  [pure virtual]

Get access to the Message Buffers so the user can replace then if supported. Returns 0 if Operation doesn't support pass thru. Returns: Pointer to an IT_Bus::ClientOperationPassThrough instance.

virtual WritableMessage& IT_Bus::ClientOperation::get_input_message (   )  [pure virtual]

Return the input message encapsulated within this client operation object. Returns: A reference to an IT_Bus::WritableMessage instance.

virtual const String& IT_Bus::ClientOperation::get_name (   )  const [virtual]

Returns the name of the operation. Returns: String

virtual ReadableMessage& IT_Bus::ClientOperation::get_output_message (   )  [pure virtual]

Return the output message encapsulated within this client operation object. Returns: A reference to an IT_Bus::ReadableMessage instance.

virtual const IT_WSDL::WSDLOperation& IT_Bus::ClientOperation::get_wsdl_operation (   )  const [virtual]

Returns a reference to the object that corresponds to the in-memory representation of the current operation. Returns: IT_WSDL::WSDLOperation instance.

virtual ContextContainer* IT_Bus::ClientOperation::reply_contexts (   )  [pure virtual]

Returns a pointer to the IT_Bus::ContextContainer that holds reply contexts. Returns: Pointer to an IT_Bus::ContextContainer instance.

virtual ContextContainer* IT_Bus::ClientOperation::request_contexts (   )  [pure virtual]

Returns a pointer to the IT_Bus::ContextContainer that holds request contexts. Returns: Pointer to an IT_Bus::ContextContainer instance.

---