skyway::room::abstract::Room クラス

Roomの操作を行う抽象クラス [詳解]

#include <skyway/room/abstract/room.hpp>

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

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

詳解

Roomの操作を行う抽象クラス

構築子と解体子

~Room()

virtual skyway::room::abstract::Room::~Room ( )

virtual

skyway::room::interface::Roomを再実装しています。

関数詳解

AddEventListener()

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

overridevirtual

イベントを購読します。

skyway::room::interface::Roomを実装しています。

Close()

bool skyway::room::abstract::Room::Close ( )

overridevirtual

Roomを閉じます。

skyway::room::interface::Roomを実装しています。

Dispose()

void skyway::room::abstract::Room::Dispose ( )

overridevirtual

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

skyway::room::interface::Roomを実装しています。

Id()

std::string skyway::room::abstract::Room::Id ( )

overridevirtual

Idを取得します。

skyway::room::interface::Roomを実装しています。

Leave()

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

overridevirtual

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

skyway::room::interface::Roomを実装しています。

Metadata()

std::optional< std::string > skyway::room::abstract::Room::Metadata ( )

overridevirtual

Metadataを取得します。

skyway::room::interface::Roomを実装しています。

Name()

std::optional< std::string > skyway::room::abstract::Room::Name ( )

overridevirtual

Nameを取得します。

skyway::room::interface::Roomを実装しています。

RemoveEventListener()

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

overridevirtual

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

skyway::room::interface::Roomを実装しています。

State()

RoomState skyway::room::abstract::Room::State ( )

overridevirtual

Stateを取得します。

skyway::room::interface::Roomを実装しています。

UpdateMetadata()

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

overridevirtual

Metadataを更新します。

skyway::room::interface::Roomを実装しています。

---

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

• include/skyway/room/abstract/room.hpp