#include <Reader.h>

Public Member Functions
	Reader ()

const std::string &	getTopic () const

Result	readNext (Message &msg)

Result	readNext (Message &msg, int timeoutMs)

Result	close ()

void	closeAsync (ResultCallback callback)

void	hasMessageAvailableAsync (HasMessageAvailableCallback callback)

Result	hasMessageAvailable (bool &hasMessageAvailable)

Detailed Description

A Reader can be used to scan through all the messages currently available in a topic.

Constructor & Destructor Documentation

pulsar::Reader::Reader ( )

Construct an uninitialized reader object

const std::string& pulsar::Reader::getTopic ( ) const

Result pulsar::Reader::hasMessageAvailable ( bool & hasMessageAvailable )

Check if there is any message available to read from the current position.

void pulsar::Reader::hasMessageAvailableAsync ( HasMessageAvailableCallback callback )

Asynchronously check if there is any message available to read from the current position.

Result pulsar::Reader::readNext ( Message & msg )

Read a single message.

If a message is not immediately available, this method will block until a new message is available.

Parameters

msg	a non-const reference where the received message will be copied

Returns: ResultOk when a message is received; ResultInvalidConfiguration if a message listener had been set in the configuration

Result pulsar::Reader::readNext	(	Message &	msg,
		int	timeoutMs
	)

Read a single message

Parameters

msg	a non-const reference where the received message will be copied
timeoutMs	the receive timeout in milliseconds

Returns: ResultOk if a message was received; ResultTimeout if the receive timeout was triggered; ResultInvalidConfiguration if a message listener had been set in the configuration

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