zep::control::DirectControlInterface Class Reference

Direct connection control function interface. More...

#include <DirectControlInterface.hpp>

Collaboration diagram for zep::control::DirectControlInterface:

Public Member Functions
virtual bool	ConnectDirect (const std::string &ip_addr, std::uint16_t port)=0
	Request a connection to a View.
virtual void	DisconnectDirect ()=0
	Requests disconnection of View.
virtual bool	SetPassPhrase (const std::string &passphrase)=0
	Request passphrase setting.
virtual void	RequestSuid ()=0
	Request SUID.
virtual void	RequestVersion ()=0
	Request Version.
virtual bool	RequestConfigDirect ()=0
	Request Direct mode configuration file information.
virtual void	RegisterCallback (const std::shared_ptr< DirectControlCallbackInterface > &listener,. bool use_weak_ptr=false)=0
	Register callback destination in shared_ptr or weak_ptr.
virtual void	RegisterCallback (std::unique_ptr< DirectControlCallbackInterface > &&listener)=0
	Register callback destinations with unique_ptr.
virtual bool	ConnectDirect (const std::string &ip_addr, std::uint16_t port)=0
	View への接続を要求する。
virtual void	DisconnectDirect ()=0
	View の切断を要求する。
virtual bool	SetPassPhrase (const std::string &passphrase)=0
	パスフレーズ設定を要求する。
virtual void	RequestSuid ()=0
	SUIDを要求する。
virtual void	RequestVersion ()=0
	Versionを要求する。
virtual bool	RequestConfigDirect ()=0
	Directモードの設定ファイル情報を要求する。
virtual void	RegisterCallback (const std::shared_ptr< DirectControlCallbackInterface > &listener, bool use_weak_ptr=false)=0
	コールバックの送信先をshared_ptrまたはweak_ptrで登録する
virtual void	RegisterCallback (std::unique_ptr< DirectControlCallbackInterface > &&listener)=0
	コールバックの送信先をunique_ptrで登録する
virtual void	StartStreaming ()=0
	ストリーミングの開始を要求する。
virtual void	StopStreaming ()=0
	ストリーミングの停止を要求する。
virtual void	RequestLineInfo (bool request_start)=0
	Line情報の取得開始/停止を要求する。

Detailed Description

Direct connection control function interface.

Direct接続制御機能のインターフェース

Member Function Documentation

ConnectDirect() [1/2]

virtual bool zep::control::DirectControlInterface::ConnectDirect ( const std::string &  ip_addr, std::uint16_t  port  )

pure virtual

Request a connection to a View.

Parameters

ip_addr	IP address
port	port number

ConnectDirect() [2/2]

virtual bool zep::control::DirectControlInterface::ConnectDirect ( const std::string &  ip_addr, std::uint16_t  port  )

pure virtual

View への接続を要求する。

Parameters

ip_addr	IPアドレス
port	ポート番号

RegisterCallback() [1/4]

virtual void zep::control::DirectControlInterface::RegisterCallback ( const std::shared_ptr< DirectControlCallbackInterface > &  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/4]

virtual void zep::control::DirectControlInterface::RegisterCallback ( const std::shared_ptr< DirectControlCallbackInterface > &  listener, . bool  use_weak_ptr = false  )

pure virtual

Register callback destination in shared_ptr or weak_ptr.

Note

Either shared_ptr/weak_ptr/unique_ptr can be used as a reference retention method.

Only one reference in total can be registered at the same time.

If a reference that does not hold a valid instance is passed, the destination is deleted.

Parameters

listener	Reference to destination
use_weak_ptr	Specify true when holding as weak_ptr

RegisterCallback() [3/4]

virtual void zep::control::DirectControlInterface::RegisterCallback ( std::unique_ptr< DirectControlCallbackInterface > &&  listener )

pure virtual

Register callback destinations with unique_ptr.

Note

Any of shared_ptr/weak_ptr/unique_ptr can be used as a reference retention method.

Only one reference in total can be registered at the same time, although both shared_ptr/weak_ptr/unique_ptr are available.

If a reference that does not hold a valid instance is passed, the destination is deleted.

Parameters

listener

Reference to the destination.

RegisterCallback() [4/4]

virtual void zep::control::DirectControlInterface::RegisterCallback ( std::unique_ptr< DirectControlCallbackInterface > &&  listener )

pure virtual

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

Note

参照の保持方式としてshared_ptr/weak_ptr/unique_ptrのいずれも 利用できるが、同時に登録できるのは合計1つの参照のみである。

有効なインスタンスを保持していない参照を渡すと、送信先を削除する。

Parameters

listener

送信先への参照

SetPassPhrase() [1/2]

virtual bool zep::control::DirectControlInterface::SetPassPhrase ( const std::string &  passphrase )

pure virtual

Request passphrase setting.

Parameters

passphrase

SetPassPhrase() [2/2]

virtual bool zep::control::DirectControlInterface::SetPassPhrase ( const std::string &  passphrase )

pure virtual

パスフレーズ設定を要求する。

Parameters

passphrase

---

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

• /Users/manabutogawa/Downloads/libzep_doxygen_src.20230515/include/zep-en/control/DirectControlInterface.hpp
• /Users/manabutogawa/Downloads/libzep_doxygen_src.20230515/include/zep/control/DirectControlInterface.hpp