rsb::spread::InPullConnector Class Reference

This class implements pull-style event receiving for the Spread transport. More...

#include <InPullConnector.h>

Inheritance diagram for rsb::spread::InPullConnector:

Collaboration diagram for rsb::spread::InPullConnector:

Public Types
typedef rsb::transport::ConverterSelectingConnector < std::string > ::ConverterSelectionStrategyPtr	ConverterSelectionStrategyPtr
Public Types inherited from rsb::transport::InPullConnector
typedef boost::shared_ptr < InPullConnector >	Ptr
Public Types inherited from rsb::transport::InConnector
typedef boost::shared_ptr < InConnector >	Ptr

Public Member Functions
	InPullConnector (ConverterSelectionStrategyPtr converters, const std::string &host=defaultHost(), unsigned int port=defaultPort())
virtual	~InPullConnector ()
std::string	getClassName () const
void	printContents (std::ostream &stream) const
void	setScope (const Scope &scope)
	Sets the scope this connector will receive events from.
void	activate ()
	Activates the connector.
void	deactivate ()
void	setQualityOfServiceSpecs (const QualityOfServiceSpec &specs)
	Requests new QoS settings for publishing events.
EventPtr	raiseEvent (bool block)

Static Public Member Functions
static transport::InPullConnector *	create (const rsc::runtime::Properties &args)

Private Attributes
rsc::logging::LoggerPtr	logger
bool	active
SpreadConnectorPtr	connector
boost::shared_ptr< Scope >	activationScope
MessageHandler	processor

Detailed Description

This class implements pull-style event receiving for the Spread transport.

Author

jmoringe

Definition at line 50 of file InPullConnector.h.

Member Typedef Documentation

typedef rsb::transport::ConverterSelectingConnector<std::string>::ConverterSelectionStrategyPtr rsb::spread::InPullConnector::ConverterSelectionStrategyPtr

Definition at line 52 of file InPullConnector.h.

Constructor & Destructor Documentation

rsb::spread::InPullConnector::InPullConnector	(	ConverterSelectionStrategyPtr	converters,
		const std::string &	host = defaultHost(),
		unsigned int	port = defaultPort()
	)

Definition at line 51 of file InPullConnector.cpp.

rsb::spread::InPullConnector::~InPullConnector ( )

virtual

Reimplemented from rsb::transport::InPullConnector.

Definition at line 60 of file InPullConnector.cpp.

References active, and deactivate().

Here is the call graph for this function:

Member Function Documentation

void rsb::spread::InPullConnector::activate ( )

virtual

Activates the connector.

Settings made between construction and activation via this method must be applied on a call to this method.

Implements rsb::transport::Connector.

Definition at line 75 of file InPullConnector.cpp.

References activationScope, active, connector, and setScope().

Here is the call graph for this function:

static transport::InPullConnector* rsb::spread::InPullConnector::create ( const rsc::runtime::Properties &  args )

static

void rsb::spread::InPullConnector::deactivate ( )

virtual

Implements rsb::transport::Connector.

Definition at line 87 of file InPullConnector.cpp.

References connector.

Referenced by ~InPullConnector().

Here is the caller graph for this function:

string rsb::spread::InPullConnector::getClassName

(

)

const

Definition at line 66 of file InPullConnector.cpp.

void rsb::spread::InPullConnector::printContents

(

std::ostream &

stream

)

const

Definition at line 70 of file InPullConnector.cpp.

References active, and connector.

EventPtr rsb::spread::InPullConnector::raiseEvent ( bool  block )

virtual

Implements rsb::transport::InPullConnector.

Definition at line 103 of file InPullConnector.cpp.

References connector, rsb::spread::MessageHandler::processMessage(), processor, and rsb::spread::SpreadMessage::REGULAR.

Here is the call graph for this function:

void rsb::spread::InPullConnector::setQualityOfServiceSpecs ( const QualityOfServiceSpec &  specs )

virtual

Requests new QoS settings for publishing events.

Does not influence the receiving part.

Parameters

specs

QoS specification

Exceptions

UnsupportedQualityOfServiceException

requirements cannot be met

Implements rsb::transport::Connector.

Definition at line 91 of file InPullConnector.cpp.

References connector.

void rsb::spread::InPullConnector::setScope ( const Scope &  scope )

virtual

Sets the scope this connector will receive events from.

Parameters

scope

scope of the connector

Implements rsb::transport::InConnector.

Definition at line 95 of file InPullConnector.cpp.

References activationScope, active, and connector.

Referenced by activate().

Here is the caller graph for this function:

Member Data Documentation

boost::shared_ptr<Scope> rsb::spread::InPullConnector::activationScope

private

Definition at line 78 of file InPullConnector.h.

Referenced by activate(), and setScope().

bool rsb::spread::InPullConnector::active

private

Definition at line 75 of file InPullConnector.h.

Referenced by activate(), printContents(), setScope(), and ~InPullConnector().

SpreadConnectorPtr rsb::spread::InPullConnector::connector

private

Definition at line 77 of file InPullConnector.h.

Referenced by activate(), deactivate(), printContents(), raiseEvent(), setQualityOfServiceSpecs(), and setScope().

rsc::logging::LoggerPtr rsb::spread::InPullConnector::logger

private

Definition at line 73 of file InPullConnector.h.

MessageHandler rsb::spread::InPullConnector::processor

private

Definition at line 79 of file InPullConnector.h.

Referenced by raiseEvent().

---

The documentation for this class was generated from the following files:

• rsb/transport/spread/InPullConnector.h
• rsb/transport/spread/InPullConnector.cpp