LocalPersonの実装クラス [詳解]

#include <local_person.hpp>

skyway::core::channel::member::LocalPerson の継承関係図

公開メンバ関数
std::shared_ptr< interface::Publication >	Publish (std::shared_ptr< LocalStream > stream, interface::LocalPerson::PublicationOptions options) override
	Streamを公開します。

std::shared_ptr< interface::Subscription >	Subscribe (const std::string &publication_id, const interface::LocalPerson::SubscriptionOptions &options) override
	公開されているPublicationを購読します。

bool	Unpublish (const std::string &publication_id) const override
	公開しているPublicationを非公開にします。

bool	Unsubscribe (const std::string &subscription_id) const override
	購読しているSubscriptionの購読を解除します。

std::vector< analytics::interface::AnalyticsClient::SubscriptionStats >	GetSubscriptionStatsForAnalytics () const override

基底クラス skyway::core::interface::Member に属する継承公開メンバ関数
void	AddEventListener (EventListener *listener)
	イベントを購読します。

void	RemoveEventListener (EventListener *listener)
	イベントの購読を中止します。

bool	UpdateMetadata (const std::string &metadata)
	Metadataを更新します

bool	Leave ()
	Channelから退室します。

std::string	Id () const
	Idを取得します。

std::optional< std::string >	Name () const
	Nameを取得します。

std::optional< std::string >	Metadata () const
	Metadataを取得します。

model::MemberType	Type () const
	MemberTypeを取得します。

std::string	Subtype () const
	Subtypeを取得します。

model::Side	Side () const
	Side(LocalかRemoteか)を取得します。

MemberState	State () const
	State(Memberの入室状態)を取得します。

std::vector< std::shared_ptr< interface::Publication > >	Publications () const
	自身が持つ全てのPublicationを取得します。

std::vector< std::shared_ptr< interface::Subscription > >	Subscriptions () const
	自身が持つ全てのSubscriptionを取得します。

その他の継承メンバ
基底クラス skyway::core::interface::LocalPerson に属する継承限定公開メンバ関数
	LocalPerson (std::shared_ptr< interface::Channel > channel, const model::Member &dto)

基底クラス skyway::core::interface::Member に属する継承限定公開メンバ関数
	Member (std::shared_ptr< interface::Channel > channel, const model::Member &initial_dto, const model::Side &side)

基底クラス skyway::core::interface::Member に属する継承限定公開変数類
std::weak_ptr< interface::Channel >	channel_

model::Member	initial_dto_

model::Side	side_

MemberState	state_

std::mutex	listeners_mtx_

std::unordered_set< EventListener * >	listeners_

std::atomic< bool >	metadata_updated_

詳解

LocalPersonの実装クラス

関数詳解

◆ Publish()

std::shared_ptr< interface::Publication > skyway::core::channel::member::LocalPerson::Publish	(	std::shared_ptr< LocalStream >	stream,
		interface::LocalPerson::PublicationOptions	options
	)

overridevirtual

Streamを公開します。

引数

stream	公開するStream
options	Publicationに指定するオプション

skyway::core::interface::LocalPersonを実装しています。

◆ Subscribe()

std::shared_ptr< interface::Subscription > skyway::core::channel::member::LocalPerson::Subscribe	(	const std::string &	publication_id,
		const interface::LocalPerson::SubscriptionOptions &	options
	)

overridevirtual

公開されているPublicationを購読します。

引数

publication_id	公開されているPublicationのId
options	Subscriptionに指定するオプション

skyway::core::interface::LocalPersonを実装しています。

◆ Unpublish()

bool skyway::core::channel::member::LocalPerson::Unpublish ( const std::string & publication_id ) const

overridevirtual

公開しているPublicationを非公開にします。

引数

publication_id 公開しているPublicationのId

skyway::core::interface::LocalPersonを実装しています。

◆ Unsubscribe()

bool skyway::core::channel::member::LocalPerson::Unsubscribe ( const std::string & subscription_id ) const

overridevirtual

購読しているSubscriptionの購読を解除します。

引数

subscription_id 公開しているSubscriptionのId

skyway::core::interface::LocalPersonを実装しています。

このクラス詳解は次のファイルから抽出されました:

include/skyway/core/channel/member/local_person.hpp

公開メンバ関数

その他の継承メンバ

詳解

関数詳解

◆ Publish()

◆ Subscribe()

◆ Unpublish()

◆ Unsubscribe()