シリアル通信トンネリング機能のインターフェース
More...
#include <TunnelInterface.hpp>
◆ GetConfigRequestStatus()
| virtual std::shared_future<TunnelConfig> zep::serial::TunnelInterface::GetConfigRequestStatus |
( |
| ) |
const |
|
pure virtualnoexcept |
設定要求状態を取得するshared_futureを取得する。
- Note
- 既に設定要求受信済みの場合、準備完了状態のオブジェクトを返却する。
- Returns
- 設定要求受信時にそのフォーマットを返却するshared_futureオブジェクト
◆ GetRequestedConfig()
| virtual bool zep::serial::TunnelInterface::GetRequestedConfig |
( |
TunnelConfig & |
config | ) |
const |
|
pure virtualnoexcept |
要求されたシリアルトンネリング設定を取得する。
- Parameters
-
- Return values
-
| true | 設定が決定している(configの内容が有効) |
| false | 設定は未決定である(configの内容は無効) |
◆ Queue()
| virtual void zep::serial::TunnelInterface::Queue |
( |
TimestampInterface::Rep |
timestamp, |
|
|
const void * |
bytes, |
|
|
std::size_t |
length |
|
) |
| |
|
pure virtual |
送信データをキューする。
- Parameters
-
| timestamp | タイムスタンプ値 |
| bytes | 送信するバイト列の先頭ポインタ |
| length | 送信するバイト列の長さ(バイト数) |
- Note
- 本関数から戻った後は bytes の先を解放/書き換えして良い。
◆ RegisterCallback() [1/2]
| virtual void zep::serial::TunnelInterface::RegisterCallback |
( |
const std::shared_ptr< TunnelCallbackInterface > & |
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 zep::serial::TunnelInterface::RegisterCallback |
( |
std::unique_ptr< TunnelCallbackInterface > && |
listener | ) |
|
|
pure virtual |
コールバックの送信先をunique_ptrで登録する
- Note
- 参照の保持方式としてshared_ptr/weak_ptr/unique_ptrのいずれも 利用できるが、同時に登録できるのは合計1つの参照のみである。
-
有効なインスタンスを保持していない参照を渡すと、送信先を削除する。
- Parameters
-
◆ ResetQueue()
| virtual void zep::serial::TunnelInterface::ResetQueue |
( |
| ) |
|
|
pure virtual |
キューされているデータを削除する。
- Note
- パケタイズ有効時は、パケットの先頭へリセットされる。
◆ SetAvailable()
| virtual void zep::serial::TunnelInterface::SetAvailable |
( |
bool |
new_value | ) |
|
|
pure virtualnoexcept |
アクティブ状態にできるか否かを設定する。
- Parameters
-
| new_value | アクティブ状態にできる場合true |
- Note
- 本関数をfalseを指定して呼び出すと、アクティブ状態の場合は 必ず非アクティブ状態へ遷移する。ただしこの遷移は非同期で行われ、 本関数から戻った時点で完了しているとは限らない。
-
本関数をtrueを指定して呼び出しても、必ずしもアクティブ状態に 遷移するとは限らない。対向側がアクティブ状態になれない場合は 非アクティブ状態を継続する。
◆ SetMaxPacketLength()
| virtual void zep::serial::TunnelInterface::SetMaxPacketLength |
( |
std::size_t |
length | ) |
|
|
pure virtual |
最大パケット長を設定する。
- Parameters
-
- Note
- パケタイズを用いない場合、設定値は無視される。
◆ SetTimestamp()
| virtual void zep::StreamInterface::SetTimestamp |
( |
const std::shared_ptr< TimestampInterface > & |
timestamp | ) |
|
|
pure virtualinherited |
このストリームで用いるタイムスタンプを設定する。
- Parameters
-
The documentation for this class was generated from the following file:
- /home/jenkins/workspace/J2303.zao_sdk_jetson.build/zep_sdk/libzep/include/zep/serial/TunnelInterface.hpp
