skyway::core::interface::Channel クラス

Channelのインターフェース [詳解]

#include <channel.hpp>

skyway::core::interface::Channel の継承関係図

クラス
class	EventListener
	イベントリスナ [詳解]

公開メンバ関数
virtual void	AddEventListener (EventListener *listener)=0
	イベントを購読します。
virtual void	RemoveEventListener (EventListener *listener)=0
	イベントの購読を中止します。
virtual std::string	Id () const =0
	Idを取得します。
virtual boost::optional< std::string >	Name () const =0
	Nameを取得します。
virtual boost::optional< std::string >	Metadata () const =0
	Metadataを取得します。
virtual interface::LocalPerson *	LocalPerson ()=0
	ChannelにJoinしているLocalPersonを取得します。
virtual std::vector< RemoteMember * >	Bots (bool active_only=true)=0
	ChannelにJoinしているBotを取得します。
virtual std::vector< Member * >	Members (bool active_only=true)=0
	ChannelにJoinしているすべてのMemberを取得します。
virtual std::vector< Publication * >	Publications (bool active_only=true)=0
	Publicationの一覧を取得します。
virtual std::vector< Subscription * >	Subscriptions (bool active_only=true)=0
	Subscriptionの一覧を取得します。
virtual ChannelState	State () const =0
	Channelの状態を取得します。
virtual interface::LocalPerson *	Join (const model::Member::Init &init)=0
	ChannelにLocalPersonを追加します。
virtual bool	Leave (Member *member)=0
	ChannelからMemberを退出させます。
virtual bool	Close ()=0
	Channelを閉じます。
virtual void	Dispose (bool remove_myself_if_needed)=0
	Channelを閉じずにChannelインスタンスを無効にし、リソースを解放します。
virtual bool	UpdateMetadata (const std::string &metadata)=0
	Metadataを更新します。

詳解

Channelのインターフェース

関数詳解

AddEventListener()

virtual void skyway::core::interface::Channel::AddEventListener ( EventListener *  listener )

pure virtual

イベントを購読します。

引数

listener

イベントリスナ

skyway::core::channel::Channelで実装されています。

Bots()

virtual std::vector< RemoteMember * > skyway::core::interface::Channel::Bots ( bool  active_only = true )

pure virtual

ChannelにJoinしているBotを取得します。

skyway::core::channel::Channelで実装されています。

Close()

virtual bool skyway::core::interface::Channel::Close ( )

pure virtual

Channelを閉じます。

サーバからの応答を同期的に待ち、ブロックします。

Disposeとは異なり、Channelを閉じるとJoinしているMemberは全て退出し、Channelは破棄されます。

Closeのコール後にChannelのリソースは破棄するのでDisposeをコールする必要はありません。

Close後のChannelインスタンスは利用できません。

skyway::core::channel::Channelで実装されています。

Dispose()

virtual void skyway::core::interface::Channel::Dispose ( bool  remove_myself_if_needed )

pure virtual

Channelを閉じずにChannelインスタンスを無効にし、リソースを解放します。

Closeとは異なり、Channelは破棄しないため入室しているMemberには影響しません。

Dispose後のChannelインスタンスは利用できません。

skyway::core::channel::Channelで実装されています。

Id()

virtual std::string skyway::core::interface::Channel::Id ( ) const

pure virtual

Idを取得します。

skyway::core::channel::Channelで実装されています。

Join()

virtual interface::LocalPerson * skyway::core::interface::Channel::Join ( const model::Member::Init &  init )

pure virtual

ChannelにLocalPersonを追加します。

サーバからの応答を同期的に待ち、ブロックします。

引数

init

初期化オプション

skyway::core::channel::Channelで実装されています。

Leave()

virtual bool skyway::core::interface::Channel::Leave ( Member *  member )

pure virtual

ChannelからMemberを退出させます。

サーバからの応答を同期的に待ち、ブロックします。

認可されていればLocalPersonだけでなく、RemoteMemberも退出させることができます。

引数

member

退出させるMember

skyway::core::channel::Channelで実装されています。

LocalPerson()

virtual interface::LocalPerson * skyway::core::interface::Channel::LocalPerson ( )

pure virtual

ChannelにJoinしているLocalPersonを取得します。

skyway::core::channel::Channelで実装されています。

Members()

virtual std::vector< Member * > skyway::core::interface::Channel::Members ( bool  active_only = true )

pure virtual

ChannelにJoinしているすべてのMemberを取得します。

このMemberはLocalPersonも含まれます。

skyway::core::channel::Channelで実装されています。

Metadata()

virtual boost::optional< std::string > skyway::core::interface::Channel::Metadata ( ) const

pure virtual

Metadataを取得します。

skyway::core::channel::Channelで実装されています。

Name()

virtual boost::optional< std::string > skyway::core::interface::Channel::Name ( ) const

pure virtual

Nameを取得します。

skyway::core::channel::Channelで実装されています。

Publications()

virtual std::vector< Publication * > skyway::core::interface::Channel::Publications ( bool  active_only = true )

pure virtual

Publicationの一覧を取得します。

skyway::core::channel::Channelで実装されています。

RemoveEventListener()

virtual void skyway::core::interface::Channel::RemoveEventListener ( EventListener *  listener )

pure virtual

イベントの購読を中止します。

引数

listener

対象のイベントリスナ

skyway::core::channel::Channelで実装されています。

State()

virtual ChannelState skyway::core::interface::Channel::State ( ) const

pure virtual

Channelの状態を取得します。

skyway::core::channel::Channelで実装されています。

Subscriptions()

virtual std::vector< Subscription * > skyway::core::interface::Channel::Subscriptions ( bool  active_only = true )

pure virtual

Subscriptionの一覧を取得します。

skyway::core::channel::Channelで実装されています。

UpdateMetadata()

virtual bool skyway::core::interface::Channel::UpdateMetadata ( const std::string &  metadata )

pure virtual

Metadataを更新します。

skyway::core::channel::Channelで実装されています。

---

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

• include/skyway/core/interface/channel.hpp