エンドポイントのクライアント制御インターフェース More...

#include <ClientInterface.hpp>

Collaboration diagram for zao::endpoint::ClientInterface:

Public Member Functions
virtual void	SetLinkPath (const std::string &link_path)=0
	リンクに用いるパス文字列(プレフィックス付き)を設定する。

virtual const std::string &	GetLinkPath () const noexcept=0
	リンクに用いるパス文字列(プレフィックス付き)を取得する。

virtual void	StartLink ()=0
	クライアントとのリンク(連携)を開始する

virtual void	StopLink ()=0
	現在リンク(連携)しているクライアントと連携を解除する

virtual bool	IsLinked () const noexcept=0
	現在リンク(連携)が成立しているか確認する。

virtual std::shared_future< std::string >	GetLinkStatus () const =0
	リンク(連携)の確立状態を返却するshared_futureを取得する。

virtual std::unique_ptr< video::FactoryInterface >	CreateVideoFactory ()=0
	このClientに紐付いたVideoFactoryを生成する。

virtual std::unique_ptr< audio::FactoryInterface >	CreateAudioFactory ()=0
	このClientに紐付いたAudioFactoryを生成する。

virtual std::unique_ptr< serial::FactoryInterface >	CreateSerialFactory ()=0
	このClientに紐付いたSerialFactoryを生成する。

virtual std::unique_ptr< control::FactoryInterface >	CreateControlFactory ()=0
	このClientに紐付いたControlFactoryを生成する。

virtual std::unique_ptr< monitor::FactoryInterface >	CreateMonitorFactory ()=0
	このClientに紐付いたMonitorFactoryを生成する。

virtual std::shared_ptr< TimestampInterface >	CreateTimestamp (std::intmax_t numerator, std::intmax_t denominator)=0
	タイムスタンプ管理オブジェクトを生成する。

template<class Ratio >
std::shared_ptr< TimestampInterface >	CreateTimestamp ()
	タイムスタンプ管理オブジェクトを std::ratioによる比率指示で生成する。

void	RegisterCallback (const std::shared_ptr< ClientCallbackInterface > &listener, bool use_weak_ptr)
	コールバックの送信先をshared_ptrまたはweak_ptrで登録する

virtual void	RegisterCallback (const std::shared_ptr< ClientCallbackInterface > &listener)=0
	コールバックの送信先をshared_ptrで登録する

virtual void	RegisterCallback (const std::weak_ptr< ClientCallbackInterface > &listener_weak, StoreAsWeakPtrType)=0
	コールバックの送信先をweak_ptrで登録する

virtual void	RegisterCallback (std::unique_ptr< ClientCallbackInterface > &&listener)=0
	コールバックの送信先をunique_ptrで登録する

Detailed Description

エンドポイントのクライアント制御インターフェース

Member Function Documentation

◆ CreateTimestamp() [1/2]

template<class Ratio >

std::shared_ptr< TimestampInterface > zao::endpoint::ClientInterface::CreateTimestamp ( )

inline

タイムスタンプ管理オブジェクトを 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

true	連携済み
false	未連携

◆ RegisterCallback() [1/4]

virtual void zao::endpoint::EventSourceInterface< ClientCallbackInterface >::RegisterCallback ( const std::shared_ptr< ClientCallbackInterface > & listener )

pure virtualinherited

コールバックの送信先をshared_ptrで登録する

Note: 参照の保持方式としてshared_ptr/weak_ptr/unique_ptrのいずれも利用できるが、同時に登録できるのは合計1つの参照のみである。; 有効なインスタンスを保持していない参照を渡すと、送信先を削除する。

Parameters

listener 送信先への参照

◆ RegisterCallback() [2/4]

void zao::endpoint::EventSourceInterface< ClientCallbackInterface >::RegisterCallback	(	const std::shared_ptr< ClientCallbackInterface > &	listener,
		bool	use_weak_ptr
	)

inlineinherited

コールバックの送信先をshared_ptrまたはweak_ptrで登録する

Note: 参照の保持方式としてshared_ptr/weak_ptr/unique_ptrのいずれも利用できるが、同時に登録できるのは合計1つの参照のみである。; 有効なインスタンスを保持していない参照を渡すと、送信先を削除する。

Parameters

listener	送信先への参照
use_weak_ptr	weak_ptrとして保持する場合にtrueを指定

Deprecated:: この関数は将来廃止予定です。 RegisterCallback(const std::shared_ptr<T>&) または RegisterCallback(const std::weak_ptr<T>&, StoreAsWeakPtrType) を使用してください。

◆ RegisterCallback() [3/4]

virtual void zao::endpoint::EventSourceInterface< ClientCallbackInterface >::RegisterCallback	(	const std::weak_ptr< ClientCallbackInterface > &	listener_weak,
		StoreAsWeakPtrType
	)

pure virtualinherited

コールバックの送信先をweak_ptrで登録する

Note: 参照の保持方式としてshared_ptr/weak_ptr/unique_ptrのいずれも利用できるが、同時に登録できるのは合計1つの参照のみである。; 有効なインスタンスを保持していない参照を渡すと、送信先を削除する。

Parameters

listener_weak 送信先への参照(所有権を持たない)

◆ RegisterCallback() [4/4]

virtual void zao::endpoint::EventSourceInterface< ClientCallbackInterface >::RegisterCallback ( std::unique_ptr< ClientCallbackInterface > && listener )

pure virtualinherited

コールバックの送信先をunique_ptrで登録する

Note: 参照の保持方式としてshared_ptr/weak_ptr/unique_ptrのいずれも利用できるが、同時に登録できるのは合計1つの参照のみである。; 有効なインスタンスを保持していない参照を渡すと、送信先を削除する。

Parameters

listener 送信先への参照

◆ SetLinkPath()

virtual void zao::endpoint::ClientInterface::SetLinkPath ( const std::string & link_path )

pure virtual

リンクに用いるパス文字列(プレフィックス付き)を設定する。

Note: パスの種類はプラットフォームにより異なる。

Parameters

link_path パス文字列

◆ StartLink()

virtual void zao::endpoint::ClientInterface::StartLink ( )

pure virtual

クライアントとのリンク(連携)を開始する

Note: リンクは非同期に行われ、連携が開始されるとコールバックで通知される。

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

/home/jenkins/workspace/J2408.zao_sdk_jetson.build/zep_sdk/libzao-endpoint/include/zao/endpoint/ClientInterface.hpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ CreateTimestamp() [1/2]

◆ CreateTimestamp() [2/2]

◆ GetLinkPath()

◆ GetLinkStatus()

◆ IsLinked()

◆ RegisterCallback() [1/4]

◆ RegisterCallback() [2/4]

◆ RegisterCallback() [3/4]

◆ RegisterCallback() [4/4]

◆ SetLinkPath()

◆ StartLink()