rwsf::Connector

rwsf::Connectorrwsf::HandleBase

• Local Index
• Header File
• Description
• Public Constructors
• Public Member Functions
• Protected Member Functions

Members

body() Connector()

getName() init()

restoreRequests() restoreSpecificRequests()

start() stop()

#include rwsf/handlers/Connector.h

Class Connector creates MessageInfo objects from a given source.

This class provides an interface for creating MessageInfo objects from a given source. Connector is a handle to a ConnectorImp, which serves as a abstract base class for implementing connectors.

Connector();

Default constructor. Constructs an invalid connector. This constructor provides the DefaultConstructible concept, but it results in an invalid object.

Connector(ConnectorImp * imp);

Constructs an instance. This constructor creates a valid connector object and is normally used by factory methods within the Agent.

Parameter descriptions

imp	The implementation of the connector.

Note

The connector still needs to be initialized before use.

init()

std::string
getName() const;

Determines the name of this connector. The name of the connector is optional and can only be set during initialization.

Return value

Name of this connector, or empty string if none provided.

void
init(const rwsf::Config & config,
    const rwsf::AgentContext & agent);

Initializes this connector. This function must be called before the object is used (started, stopped, or accessed). If the agent has already been configured, this will call the connector's reinit function.

Parameter descriptions

config	The configuration of the Agent.
agent	The context of the Agent.

void
restoreRequests(bool startup);

Restores persisted request, if any.

void
restoreSpecificRequests(const std::vector< std::string > & requestKeys);

Restores the persisted requests specified by the vector of persistence keys passed in

void
start();

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

void
stop();

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

const rwsf::ConnectorImp &
body() const;

Reimplements method in rwsf::HandleBase

Base class documentation:

Gets a reference for the body instance, if any; otherwise, throws an rwsf::Exception exception.

Implementation documentation:

Returns the underlying body implementation.

rwsf::ConnectorImp &
body();

Reimplements method in rwsf::HandleBase

Base class documentation:

Gets a reference for the body instance, if any; otherwise, throws an rwsf::Exception exception.

Implementation documentation:

Returns the underlying body implementation.

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