skyway::room::Room クラス

DefaultRoomの操作を行うクラス [詳解]

#include <skyway/room/room.hpp>

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

公開メンバ関数
RoomType	Type () override
	RoomのTypeを取得します。
std::vector< std::shared_ptr< interface::RoomPublication > >	Publications () override
	Roomに存在するPublicationを取得します。
std::vector< std::shared_ptr< interface::RoomSubscription > >	Subscriptions () override
	Roomに存在するSubscriptionを取得します。
std::vector< std::shared_ptr< interface::RoomMember > >	Members () override
	Roomに存在するMemberを取得します。
std::shared_ptr< LocalRoomMember >	Join (interface::RoomMemberInitOptions options)
	Roomへ参加します。
基底クラス 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ではイベントが発火しなくなります。

静的公開メンバ関数
static std::shared_ptr< Room >	Create (interface::RoomInitOptions options, std::unique_ptr< interface::RoomFactory > room_factory=std::make_unique< RoomFactory >(), std::unique_ptr< interface::RoomDomainFactory > domain_factory=std::make_unique< RoomDomainFactory >())
	Roomを作成します。
static std::shared_ptr< Room >	Create ()
	Roomを作成します。
static std::shared_ptr< Room >	Find (interface::RoomQuery query, std::unique_ptr< interface::RoomFactory > room_factory=std::make_unique< RoomFactory >(), std::unique_ptr< interface::RoomDomainFactory > domain_factory=std::make_unique< RoomDomainFactory >())
	Roomの検索をします。
static std::shared_ptr< Room >	FindOrCreate (interface::RoomInitOptions options, std::unique_ptr< interface::RoomFactory > room_factory=std::make_unique< RoomFactory >(), std::unique_ptr< interface::RoomDomainFactory > domain_factory=std::make_unique< RoomDomainFactory >())
	Roomの検索をし、存在しなければ作成します。

詳解

DefaultRoomの操作を行うクラス

構築子と解体子

~Room()

skyway::room::Room::~Room ( )

overridevirtual

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

関数詳解

Members()

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

overridevirtual

Roomに存在するMemberを取得します。

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

Publications()

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

overridevirtual

Roomに存在するPublicationを取得します。

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

Subscriptions()

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

overridevirtual

Roomに存在するSubscriptionを取得します。

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

Type()

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

overridevirtual

RoomのTypeを取得します。

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

---

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

• include/skyway/room/room.hpp