zao::endpoint::serial::TunnelCallbackInterface Class Reference

シリアル通信トンネリング機能のコールバックインターフェース More...

#include <TunnelInterface.hpp>

Public Types
enum class	EventType {   kUnknown = 0 , kDisconnected , kUnlinked , kDepacketizeError ,   kDeactivated , kActivated }
	イベントの種類 More...

Public Member Functions
virtual void	OnRequestConfig (const TunnelConfig &config)=0
	設定要求時に呼び出されるコールバック。
virtual void	OnNotifyTunnelEvent (EventType type, const std::string &message)
	エラーなどのイベントが発生した時に呼び出されるコールバック
virtual void	OnReceivePacket (std::vector< std::uint8_t > &&bytes)
	パケット受信時に呼び出されるコールバック。
virtual	~TunnelCallbackInterface () noexcept=default
	TunnelCallbackInterface オブジェクトを破棄する。

Detailed Description

シリアル通信トンネリング機能のコールバックインターフェース

Member Enumeration Documentation

EventType

enum class zao::endpoint::serial::TunnelCallbackInterface::EventType

strong

イベントの種類

Enumerator
kUnknown	不明(未初期化の初期値等に用いる)
kDisconnected	クラウドから切断された
kUnlinked	クライアント連携が解除された
kDepacketizeError	デパケタイズ処理でエラーが発生した
kDeactivated	デバイス切断等により非アクティブ状態になった
kActivated	双方のデバイス復活等によりアクティブ状態になった

Member Function Documentation

OnNotifyTunnelEvent()

virtual void zao::endpoint::serial::TunnelCallbackInterface::OnNotifyTunnelEvent ( EventType  type, const std::string &  message  )

inlinevirtual

エラーなどのイベントが発生した時に呼び出されるコールバック

Parameters

type	イベントの種類
message	追加メッセージ

OnReceivePacket()

virtual void zao::endpoint::serial::TunnelCallbackInterface::OnReceivePacket ( std::vector< std::uint8_t > &&  bytes )

inlinevirtual

パケット受信時に呼び出されるコールバック。

Deprecated:

新しいPull型APIを選択した場合は使用されません。

Parameters

bytes

パケットのバイト列を格納したvector

Note

データはムーブで渡されるため、 コールバック内で自由に変更/再ムーブして構わない。

OnRequestConfig()

virtual void zao::endpoint::serial::TunnelCallbackInterface::OnRequestConfig ( const TunnelConfig &  config )

pure virtual

設定要求時に呼び出されるコールバック。

Parameters

config

要求された設定

Note

本コールバック内では、GetRequestedConfig()はtrueを返却する。

---

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

• /home/jenkins/workspace/J2412.zao_sdk_jetson.build/zep_sdk/libzao-endpoint/include/zao/endpoint/serial/TunnelInterface.hpp