Specification of desired quality of service settings for sending and receiving events. More...

#include <QualityOfServiceSpec.h>

Inheritance diagram for rsb::QualityOfServiceSpec:

Collaboration diagram for rsb::QualityOfServiceSpec:

Public Types
enum	Ordering { UNORDERED = 10, ORDERED = 20 }
	Specifies the ordering of events for listeners on a informer. More...

enum	Reliability { UNRELIABLE = 10, RELIABLE = 20 }
	Specifies the reliability of messages. More...

Public Member Functions
	QualityOfServiceSpec ()
	Constructs the default QoS specs for every informers. More...

	QualityOfServiceSpec (Ordering ordering, Reliability reliability)
	Constructs a new QoS specification with desired details. More...

virtual	~QualityOfServiceSpec ()
	Destructor. More...

Ordering	getOrdering () const
	Returns the desired ordering settings. More...

Reliability	getReliability () const
	Returns the desired reliability settings. More...

bool	operator== (const QualityOfServiceSpec &other) const

Private Attributes
Ordering	ordering

Reliability	reliability

Friends
class	ParticipantConfig

RSB_EXPORT std::ostream &	operator<< (std::ostream &stream, const QualityOfServiceSpec &spec)

Detailed Description

Specification of desired quality of service settings for sending and receiving events.

Specification given here are required "at least". This means concrete port instances can implement "better" QoS specs without any notification to the clients. Better is decided by the integer value of the specification enums. Higher values mean better services.

Author: jwienke

Definition at line 46 of file QualityOfServiceSpec.h.

Member Enumeration Documentation

enum rsb::QualityOfServiceSpec::Ordering

Specifies the ordering of events for listeners on a informer.

Author: jwienke

Enumerator

UNORDERED

The events are delivered in arbitrary order.

ORDERED

Every listener receives the events of one informer in the order the informer sent the events.

No guarantees are given for events of multiple informers.

Definition at line 56 of file QualityOfServiceSpec.h.

enum rsb::QualityOfServiceSpec::Reliability

Specifies the reliability of messages.

Author: jwienke

Enumerator

UNRELIABLE

Events may be dropped and not be visible to a listener.

RELIABLE

Messages are guaranteed to be delivered.

Otherwise an error is raised.

Definition at line 74 of file QualityOfServiceSpec.h.

Constructor & Destructor Documentation

rsb::QualityOfServiceSpec::QualityOfServiceSpec ( )

Constructs the default QoS specs for every informers.

Messages are unordered but reliably.

Definition at line 33 of file QualityOfServiceSpec.cpp.

rsb::QualityOfServiceSpec::QualityOfServiceSpec	(	Ordering	ordering,
		Reliability	reliability
	)

Constructs a new QoS specification with desired details.

Parameters

ordering	desired ordering type
reliability	desired reliability type

Definition at line 37 of file QualityOfServiceSpec.cpp.

rsb::QualityOfServiceSpec::~QualityOfServiceSpec ( )

virtual

Destructor.

Definition at line 42 of file QualityOfServiceSpec.cpp.

Member Function Documentation

QualityOfServiceSpec::Ordering rsb::QualityOfServiceSpec::getOrdering ( ) const

Returns the desired ordering settings.

Returns: ordering requirements

Definition at line 45 of file QualityOfServiceSpec.cpp.

References ordering.

QualityOfServiceSpec::Reliability rsb::QualityOfServiceSpec::getReliability ( ) const

Returns the desired reliability settings.

Returns: reliability requirements

Definition at line 49 of file QualityOfServiceSpec.cpp.

References reliability.

bool rsb::QualityOfServiceSpec::operator== ( const QualityOfServiceSpec & other ) const

Definition at line 53 of file QualityOfServiceSpec.cpp.

References ordering, and reliability.

Friends And Related Function Documentation

RSB_EXPORT std::ostream& operator<<	(	std::ostream &	stream,
		const QualityOfServiceSpec &	spec
	)

friend

Definition at line 57 of file QualityOfServiceSpec.cpp.

friend class ParticipantConfig

friend

Definition at line 48 of file QualityOfServiceSpec.h.

Member Data Documentation

Ordering rsb::QualityOfServiceSpec::ordering

private

Definition at line 126 of file QualityOfServiceSpec.h.

Referenced by getOrdering(), rsb::ParticipantConfig::handleOption(), rsb::operator<<(), and operator==().

Reliability rsb::QualityOfServiceSpec::reliability

private

Definition at line 127 of file QualityOfServiceSpec.h.

Referenced by getReliability(), rsb::ParticipantConfig::handleOption(), rsb::operator<<(), and operator==().

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

rsb/QualityOfServiceSpec.h
rsb/QualityOfServiceSpec.cpp

Public Types

Public Member Functions