irlab::shm::Subscriber< T > Class Template Reference

共有メモリからトピックを取得する購読者を表現するクラス More...

#include <shm_pub_sub.hpp>

Public Member Functions
	Subscriber (std::string name="", bool legacy=false)
	コンストラクタ More...
	~Subscriber ()
	デストラクタ More...
const T	subscribe (bool *state)
	トピックを読み込む More...
bool	waitFor (uint64_t timeout_usec)
void	setDataExpiryTime_us (uint64_t time_us)

Detailed Description

template<typename T>
class irlab::shm::Subscriber< T >

共有メモリからトピックを取得する購読者を表現するクラス

template classとして与えられた型またはクラスをトピックとして読み込むためのクラスである． また、トピックが更新されるまで待機するAPIを持つ．

Examples

test1.cpp.

Definition at line 91 of file shm_pub_sub.hpp.

Constructor & Destructor Documentation

Subscriber()

template<typename T >

irlab::shm::Subscriber< T >::Subscriber	(	std::string	name = "",
		bool	legacy = false
	)

コンストラクタ

Parameters

[in]

name

共有メモリ名

Returns

なし

共有メモリへのアクセスを行う．

Definition at line 247 of file shm_pub_sub.hpp.

~Subscriber()

template<typename T >

irlab::shm::Subscriber< T >::~Subscriber

デストラクタ

Returns

なし

確保したローカルのメンバーを開放する．

Definition at line 277 of file shm_pub_sub.hpp.

Member Function Documentation

subscribe()

template<typename T >

const T irlab::shm::Subscriber< T >::subscribe

(

bool *

is_success

)

トピックを読み込む

Parameters

None

なし

Returns

const T& 読み込んだトピックへのconst参照

タイムスタンプが最も新しいトピックを読み込む． 後々可変長なクラスに拡張できるように、メモリへの直接的な参照を返すので、コピーコンストラクタや代入によってデータを複製することを推奨する．

Definition at line 301 of file shm_pub_sub.hpp.

---

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

• shm_pub_sub/include/shm_pub_sub.hpp