rwsf::ClientImp

rwsf::ClientImprwsf::MessageHandlerImp

• Local Index
• Header File
• Description
• Protected Data Members
• Public Constructors
• Public Destructors
• Public Member Functions
• Protected Member Functions

Members

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

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

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

setProperty() setTransport() theTransport_ ~ClientImp()

#include rwsf/webservice/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.

rwsf::Transport theTransport_;

An instance of rwsf::Transport.

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);

Reimplements method in rwsf::MessageHandlerImp

Base class documentation:

Virtual. Initializes this handler. The values of the parameter initParams comes from the handlers.xmlfile defining the chains for this service.

Implementation documentation:

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

void
invoke(rwsf::CallInfo & callInfo);

Reimplements method in rwsf::MessageHandlerImp

Base class documentation:

Virtual. Calling services that will use this handle access it through this method, which implements the main functionality of a service. To create a handler, extend this class and implement this method in the derived class.

Implementation documentation:

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.

void
setProperty(const std::string & key,
    const std::string & value);

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.

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.

© Copyright Rogue Wave Software, Inc. All Rights Reserved. All Rights Reserved. Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. HydraExpress is a trademark of Rogue Wave Software, Inc. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.