skyway::room::interface::Room クラス

Roomの操作を行うインターフェース [詳解]

#include <room.hpp>

skyway::room::interface::Room の継承関係図

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

公開メンバ関数
virtual std::string	Id ()=0
	Idを取得します。
virtual boost::optional< std::string >	Name ()=0
	Nameを取得します。
virtual RoomType	Type ()=0
	RoomのTypeを取得します。
virtual boost::optional< std::string >	Metadata ()=0
	Metadataを取得します。
virtual core::interface::ChannelState	State ()=0
	Stateを取得します。
virtual std::vector< std::unique_ptr< RoomPublication > >	Publications ()=0
	Roomインスタンスに紐づくPublicationの一覧を取得します。
virtual std::vector< std::unique_ptr< RoomSubscription > >	Subscriptions ()=0
	Roomインスタンスに紐づくSubscriptionの一覧を取得します。
virtual std::vector< std::unique_ptr< RoomMember > >	Members ()=0
	Roomインスタンスに紐づくRoomMemberの一覧を取得します。
virtual void	AddEventListener (EventListener *listener)=0
	イベントを購読します。
virtual void	RemoveEventListener (EventListener *listener)=0
	イベントの購読を中止します。
virtual bool	UpdateMetadata (const std::string &metadata)=0
	Metadataを更新します。
virtual bool	Leave (RoomMember *member)=0
	指定したMemberをRoomから退室させます。
virtual bool	Close ()=0
	Roomを閉じます。
virtual void	Dispose ()=0
	Roomを破棄します。破棄されたRoomではイベントが発火しなくなります。

詳解

Roomの操作を行うインターフェース

関数詳解

AddEventListener()

virtual void skyway::room::interface::Room::AddEventListener ( EventListener *  listener )

pure virtual

イベントを購読します。

skyway::room::abstract::Roomで実装されています。

Close()

virtual bool skyway::room::interface::Room::Close ( )

pure virtual

Roomを閉じます。

skyway::room::abstract::Roomで実装されています。

Dispose()

virtual void skyway::room::interface::Room::Dispose ( )

pure virtual

Roomを破棄します。破棄されたRoomではイベントが発火しなくなります。

skyway::room::abstract::Roomで実装されています。

Id()

virtual std::string skyway::room::interface::Room::Id ( )

pure virtual

Idを取得します。

skyway::room::abstract::Roomで実装されています。

Leave()

virtual bool skyway::room::interface::Room::Leave ( RoomMember *  member )

pure virtual

指定したMemberをRoomから退室させます。

skyway::room::abstract::Roomで実装されています。

Members()

virtual std::vector< std::unique_ptr< RoomMember > > skyway::room::interface::Room::Members ( )

pure virtual

Roomインスタンスに紐づくRoomMemberの一覧を取得します。

skyway::room::abstract::Roomで実装されています。

Metadata()

virtual boost::optional< std::string > skyway::room::interface::Room::Metadata ( )

pure virtual

Metadataを取得します。

skyway::room::abstract::Roomで実装されています。

Name()

virtual boost::optional< std::string > skyway::room::interface::Room::Name ( )

pure virtual

Nameを取得します。

skyway::room::abstract::Roomで実装されています。

Publications()

virtual std::vector< std::unique_ptr< RoomPublication > > skyway::room::interface::Room::Publications ( )

pure virtual

Roomインスタンスに紐づくPublicationの一覧を取得します。

skyway::room::abstract::Roomで実装されています。

RemoveEventListener()

virtual void skyway::room::interface::Room::RemoveEventListener ( EventListener *  listener )

pure virtual

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

skyway::room::abstract::Roomで実装されています。

State()

virtual core::interface::ChannelState skyway::room::interface::Room::State ( )

pure virtual

Stateを取得します。

skyway::room::abstract::Roomで実装されています。

Subscriptions()

virtual std::vector< std::unique_ptr< RoomSubscription > > skyway::room::interface::Room::Subscriptions ( )

pure virtual

Roomインスタンスに紐づくSubscriptionの一覧を取得します。

skyway::room::abstract::Roomで実装されています。

Type()

virtual RoomType skyway::room::interface::Room::Type ( )

pure virtual

RoomのTypeを取得します。

skyway::room::p2p::P2PRoomで実装されています。

UpdateMetadata()

virtual bool skyway::room::interface::Room::UpdateMetadata ( const std::string &  metadata )

pure virtual

Metadataを更新します。

skyway::room::abstract::Roomで実装されています。

---

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

• include/skyway/room/interface/room.hpp