HydraExpress™ C++ API Reference Guide

Product Documentation:
   HydraExpress C++
Documentation Home
List of all members | Public Member Functions
rwsf::MessageHandler Class Reference

Base handler class for all defined proxies, services, skeletons, loggers, and tranports, as well as custom handlers. More...

#include <rwsf/webservice/MessageHandler.h>

Inheritance diagram for rwsf::MessageHandler:
rwsf::HandleBase rwsf::Client rwsf::MessageListener rwsf::Transport

Public Member Functions

 MessageHandler ()
 MessageHandler (const MessageHandler &handler)
 MessageHandler (MessageHandlerImp *impl)
 ~MessageHandler ()
void destroy ()
void init (const rwsf::Config &initParams)
void invoke (rwsf::CallInfo &callInfo)
MessageHandleroperator= (const MessageHandler &obj)
- Public Member Functions inherited from rwsf::HandleBase
bool isValid (void) const
bool operator!= (const HandleBase &second) const
bool operator== (const HandleBase &second) const

Additional Inherited Members

- Protected Member Functions inherited from rwsf::HandleBase
 HandleBase (void)
 HandleBase (StaticCtor)
 HandleBase (BodyBase *body)
 HandleBase (const HandleBase &second)
virtual ~HandleBase (void)
BodyBase & body (void) const
HandleBaseoperator= (const HandleBase &second)

Detailed Description

This class, with MessageHandlerImp, implements the handle/body idiom in which rwsf::MessageHandler is the base handler class for all proxies, services, skeletons, loggers, and transports defined by the system, while rwsf::MessageHandlerImp is the base body class. For more information about RWSF message handlers, see the Handlers chapter in the Web Service Development Guide.

This class uses reference semantics wherein copies and assignments always point to the same object instance.

Constructor & Destructor Documentation

rwsf::MessageHandler::MessageHandler ( )

Default constructor. Creates an empty message handler.

rwsf::MessageHandler::MessageHandler ( const MessageHandler handler)

Copy constructor.

rwsf::MessageHandler::MessageHandler ( MessageHandlerImp impl)

Constructs a new handle attached to the body impl, and increments a reference count.

rwsf::MessageHandler::~MessageHandler ( )


Member Function Documentation

void rwsf::MessageHandler::destroy ( )

Provides the message handler a chance to perform cleanup tasks and deallocate resources. A message handler should perform all resource deallocation and cleanup tasks in the destroy() method, rather than in its destructor.

void rwsf::MessageHandler::init ( const rwsf::Config initParams)

Initializes this handler. The values of the parameter initParams come from the handlers.xml file that defines the handler chains for this service.

void rwsf::MessageHandler::invoke ( rwsf::CallInfo callInfo)

This method implements the main functionality of a service and is called by any service or client invoking the service.

MessageHandler& rwsf::MessageHandler::operator= ( const MessageHandler obj)

Assignment operator.

Copyright © 2020 Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is registered trademark of Rogue Wave Software, Inc. in the United States and other countries, and HydraExpress is a trademark of Rogue Wave Software. All other trademarks are the property of their respective owners.
Provide feedback to Rogue Wave about its documentation.