rwsf::ClientImp

rwsf::ClientImp  rwsf::MessageHandlerImp

• Local Index
• Header File
• Description
• Public Constructor
• Destructor
• Public Member Functions
• Protected Members

Members

addFaultHandler() addGlobalRequestHandler() addGlobalResponseHandler() addServiceRequestHandler()

addServiceResponseHandler() addTransportHandler() callFaultHandler() checkHandle()

ClientImp() getProperty() init() invoke()

setProperty() setTransport() theTransport_ ~ClientImp()

#include <rw/rwsf/soapworx/Client.h> 

All generated client proxies derive from rwsf::ClientImp. Clients are handlers in rwsf, so this class derives from rwsf::MessageHandlerImp.

rwsf::ClientImp includes methods for adding handlers to the client, and an invoke() method. All service operation methods in the generated client proxies call rwsf::Client::invoke() to build the SOAP message and pass it on to the transport.

rwsf::ClientImp implements the handle/body idiom in which rwsf::ClientImp is the body and rwsf::Client is the handle.

ClientImp();

Default constructor.

virtual 
~ClientImp();

Virtual. Destroys the client and disconnects the transport if it exists.

void 
addFaultHandler(const rwsf::MessageHandler& handler);

Adds a fault handler to the client.

void 
addGlobalRequestHandler(const rwsf::MessageHandler& handler);

Adds a global request handler to this client.

void 
addGlobalResponseHandler(const rwsf::MessageHandler& handler);

Adds a global request handler to this client.

void 
addServiceRequestHandler(const rwsf::MessageHandler& handler);

Adds a service request handler to this client.

void 
addServiceResponseHandler(const rwsf::MessageHandler& handler);

Adds a service response handler to this client.

void 
addTransportHandler(const rwsf::MessageHandler& handler);

Adds a transport handler to this client.

std::string 
getProperty(const std::string& key) const;

Returns the initialization parameter represented by key.

void 
init(const rwsf::Config& initParams);

Initializes the client object. This method can be used to initialize client properties with an existing rwsf::Config object.

virtual void 
invoke(rwsf::CallInfo& callInfo);

For client requests, builds the handler chain with all included handlers, adds SOAP headers, prepares the request for SOAP processing, and passes it on to the transport. All service operation methods in generated client proxies call this method.

If it encounters an error condition (such as no SOAP message in the response, or transport failure), throws a rwsf::Exception.

virtual void 
setProperty(const std::string& key, const std::string&

Sets a property on the client. Used to set the property rwsf:doEScape to define whether or not text will be escaped.

void 
setTransport(const rwsf::Transport& transport);

Sets the transport for this client to transport, disconnecting any other existing transport.

rwsf::Transport theTransport_;

An instance of rwsf::Transport.

void 
callFaultHandler(rwsf::CallInfo& callInfo, const char *message);

Invokes the fault handler chain with the message in message.

void 
checkHandle(const AsyncThread* thread);

Used for asynchronous processing. Checks to see if the thread is valid. If not, throws a rwsf::Exception.

©2004-2007 Copyright Quovadx, Inc. All Rights Reserved.
Quovadx and Rogue Wave are registered trademarks of Quovadx, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.