rad::SMRequestor< TYPEREQ, TYPEREP > Class Template Reference

#include <smRequestor.hpp>

Public Member Functions
	SMRequestor (const std::string &endpoint, const std::string &identity, boost::asio::io_service &ios, SMAdapter &sm, UniqueEvent &&ok_event, UniqueEvent &&err_event, UniqueEvent &&timeout_event)
virtual	~SMRequestor ()
size_t	Send (const TYPEREQ &payload, const long timeout=0)
const TYPEREP &	GetReplyPayload ()
	SMRequestor (const SMRequestor &)=delete
SMRequestor &	operator= (const SMRequestor &)=delete
	SMRequestor (const std::string &endpoint, const std::string &identity, boost::asio::io_service &ios, SMAdapter &sm, UniqueEvent &&ok_event, UniqueEvent &&err_event, UniqueEvent &&timeout_event)
virtual	~SMRequestor ()
size_t	Send (const TYPEREQ &payload, const long timeout=0)
const TYPEREP &	GetReplyPayload ()
	SMRequestor (const SMRequestor &)=delete
SMRequestor &	operator= (const SMRequestor &)=delete

Detailed Description

template<typename TYPEREQ, typename TYPEREP>
class rad::SMRequestor< TYPEREQ, TYPEREP >

This class allows to send requests and, when a reply is received to trigger one of the following events:

• OK event associated to an OK reply
• ERR event associated to an Error reply
• Timeout event associated to a missing reply The events are injected by the user via the constructor.

Constructor & Destructor Documentation

template<typename TYPEREQ , typename TYPEREP >

rad::SMRequestor< TYPEREQ, TYPEREP >::SMRequestor	(	const std::string &	endpoint,
		const std::string &	identity,
		boost::asio::io_service &	ios,
		SMAdapter &	sm,
		UniqueEvent &&	ok_event,
		UniqueEvent &&	err_event,
		UniqueEvent &&	timeout_event
	)

Constructor for the SMRequestor class.

Parameters

[in]	endpoint	Where to send the request.
[in]	identity	Identity of the request (used by ZMQ to associated the reply).
[in]	ios	Reference to the event loop.
[in]	sm	SM Adapter used to trigger events.
[in]	ok_event	OK event associated to an OK reply.
[in]	err_event	ERR event associated to an Error reply.
[in]	timeout_event	Timeout event associated to a missing reply.

template<typename TYPEREQ , typename TYPEREP >

rad::SMRequestor< TYPEREQ, TYPEREP >::~SMRequestor ( )

virtual

Denstructor for the SMRequestor class.

template<typename TYPEREQ, typename TYPEREP>

rad::SMRequestor< TYPEREQ, TYPEREP >::SMRequestor ( const SMRequestor< TYPEREQ, TYPEREP > &  )

delete

template<typename TYPEREQ, typename TYPEREP>

rad::SMRequestor< TYPEREQ, TYPEREP >::SMRequestor	(	const std::string &	endpoint,
		const std::string &	identity,
		boost::asio::io_service &	ios,
		SMAdapter &	sm,
		UniqueEvent &&	ok_event,
		UniqueEvent &&	err_event,
		UniqueEvent &&	timeout_event
	)

template<typename TYPEREQ, typename TYPEREP>

virtual rad::SMRequestor< TYPEREQ, TYPEREP >::~SMRequestor ( )

virtual

template<typename TYPEREQ, typename TYPEREP>

rad::SMRequestor< TYPEREQ, TYPEREP >::SMRequestor ( const SMRequestor< TYPEREQ, TYPEREP > &  )

delete

Member Function Documentation

template<typename TYPEREQ , typename TYPEREP >

const TYPEREP & rad::SMRequestor< TYPEREQ, TYPEREP >::GetReplyPayload

(

)

Returns

the payload associated to the reply.

template<typename TYPEREQ, typename TYPEREP>

const TYPEREP& rad::SMRequestor< TYPEREQ, TYPEREP >::GetReplyPayload

(

)

template<typename TYPEREQ, typename TYPEREP>

SMRequestor& rad::SMRequestor< TYPEREQ, TYPEREP >::operator= ( const SMRequestor< TYPEREQ, TYPEREP > &  )

delete

template<typename TYPEREQ, typename TYPEREP>

SMRequestor& rad::SMRequestor< TYPEREQ, TYPEREP >::operator= ( const SMRequestor< TYPEREQ, TYPEREP > &  )

delete

template<typename TYPEREQ, typename TYPEREP>

size_t rad::SMRequestor< TYPEREQ, TYPEREP >::Send	(	const TYPEREQ &	payload,
		const long	timeout = 0
	)

template<typename TYPEREQ, typename TYPEREP >

size_t rad::SMRequestor< TYPEREQ, TYPEREP >::Send	(	const TYPEREQ &	payload,
		const long	timeout = 0
	)

Send a request message to an destination process.

Parameters

payload	Request's payload.
timeout	Timeout in msec.

Returns

The number of bytes sent.

---

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

• INTROOT/include/rad/smRequestor.hpp
• rad/cpp/sm/src/include/rad/smRequestor.hpp