エンドポイントのクライアント制御インターフェース
More...
#include <ClientInterface.hpp>
◆ CreateTimestamp() [1/2]
タイムスタンプ管理オブジェクトを std::ratioによる比率指示で生成する。
- Template Parameters
-
| Ratio | 1秒に対する進み具合(比率)を示すstd::ratioクラス |
◆ CreateTimestamp() [2/2]
| virtual std::shared_ptr< TimestampInterface > zao::endpoint::ClientInterface::CreateTimestamp |
( |
std::intmax_t |
numerator, |
|
|
std::intmax_t |
denominator |
|
) |
| |
|
pure virtual |
タイムスタンプ管理オブジェクトを生成する。
- Parameters
-
| numerator | 1秒に対する進み具合(比率)の分子 |
| denominator | 1秒に対する進み具合(比率)の分母 |
◆ GetLinkPath()
| virtual const std::string & zao::endpoint::ClientInterface::GetLinkPath |
( |
| ) |
const |
|
pure virtualnoexcept |
リンクに用いるパス文字列(プレフィックス付き)を取得する。
- Note
- パスの種類はプラットフォームにより異なる。
◆ GetLinkStatus()
| virtual std::shared_future< std::string > zao::endpoint::ClientInterface::GetLinkStatus |
( |
| ) |
const |
|
pure virtual |
リンク(連携)の確立状態を返却するshared_futureを取得する。
- Note
- 既に確立済みの場合、準備完了状態のオブジェクトを返却する。
- Returns
- リンク(連携)確立時にそのパスを返却する shared_futureオブジェクト
◆ IsLinked()
| virtual bool zao::endpoint::ClientInterface::IsLinked |
( |
| ) |
const |
|
pure virtualnoexcept |
現在リンク(連携)が成立しているか確認する。
- Return values
-
◆ RegisterCallback() [1/2]
| virtual void zao::endpoint::ClientInterface::RegisterCallback |
( |
const std::shared_ptr< ClientCallbackInterface > & |
listener, |
|
|
bool |
use_weak_ptr = false |
|
) |
| |
|
pure virtual |
コールバックの送信先をshared_ptrまたはweak_ptrで登録する
- Note
- 参照の保持方式としてshared_ptr/weak_ptr/unique_ptrのいずれも 利用できるが、同時に登録できるのは合計1つの参照のみである。
-
有効なインスタンスを保持していない参照を渡すと、 送信先を削除する。
- Parameters
-
| listener | 送信先への参照 |
| use_weak_ptr | weak_ptrとして保持する場合にtrueを指定 |
◆ RegisterCallback() [2/2]
| virtual void zao::endpoint::ClientInterface::RegisterCallback |
( |
std::unique_ptr< ClientCallbackInterface > && |
listener | ) |
|
|
pure virtual |
コールバックの送信先をunique_ptrで登録する
- Note
- 参照の保持方式としてshared_ptr/weak_ptr/unique_ptrのいずれも 利用できるが、同時に登録できるのは合計1つの参照のみである。
-
有効なインスタンスを保持していない参照を渡すと、 送信先を削除する。
- Parameters
-
◆ SetLinkPath()
| virtual void zao::endpoint::ClientInterface::SetLinkPath |
( |
const std::string & |
link_path | ) |
|
|
pure virtual |
リンクに用いるパス文字列(プレフィックス付き)を設定する。
- Note
- パスの種類はプラットフォームにより異なる。
- Parameters
-
◆ StartLink()
| virtual void zao::endpoint::ClientInterface::StartLink |
( |
| ) |
|
|
pure virtual |
クライアントとのリンク(連携)を開始する
- Note
- リンクは非同期に行われ、 連携が開始されるとコールバックで通知される。
The documentation for this class was generated from the following file:
- /home/jenkins/workspace/J2310.zao_sdk_jetson.build/zep_sdk/libzao-endpoint/include/zao/endpoint/ClientInterface.hpp
