HydraExpress™ C++ API Reference Guide

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

Reference to all connector implementations. More...

#include <rwsf/handlers/Connector.h>

Inheritance diagram for rwsf::Connector:
rwsf::HandleBase

Public Member Functions

std::string getName () const
 
void start ()
 
void stop ()
 
- 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

rwsf::Connector is the handle of a bridge pattern where the implementation is defined via rwsf::ConnectorImp. A connector provides an end point for services and creates rwsf::MessageInfo objects specific to the endpoint and external payload which are then passed through the handler chain with which the connector is configured.

If you wish to create custom connectors, derive from rwsf::ConnectorImp.

See also
rwsf::ConnectorImp
Note
This class uses reference semantics in which an instance of this class represents a reference to the implementation class rwsf::ConnectorImp.

Member Function Documentation

std::string rwsf::Connector::getName ( ) const

Returns the name of this connector, or an empty string if none is provided. The name of the connector is optional and can be set only during initialization.

void rwsf::Connector::start ( )

Starts this connector. This function should not block execution of the process; that is, it should return control immediately to the caller.

void rwsf::Connector::stop ( )

Stops this connector. This function should block execution of the process until completed.

Copyright © 2019 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.