Session機能のためのインターフェースクラス [詳解]

#include <session.h>

公開メンバ関数
virtual	~IDiarkisSession ()
	IDiarkisSessionのデストラクタ [詳解]

virtual void	SetLoggerFactory (const std::shared_ptr< IDiarkisLoggerFactory > &loggerFactory, const Diarkis::StdString &loggerNameSuffix)=0
	ロガーを登録します。 [詳解]

virtual bool	SetupAsTcp (std::shared_ptr< IDiarkisTcp > tcp)=0
	SessionをTCPプロトコルとして設定します。 [詳解]

virtual bool	SetupAsUdp (std::shared_ptr< IDiarkisUdp > udp)=0
	UDPプロトコルを使用したセッションの設定。 [詳解]

virtual bool	SetTcp (std::shared_ptr< IDiarkisTcp > tcp)=0
	IDiarkisTcpクラスを設定します [詳解]

virtual bool	SetUdp (std::shared_ptr< IDiarkisUdp > udp)=0
	IDiarkisUdpクラスを設定します [詳解]

virtual std::shared_ptr< IDiarkisEvent< const DiarkisSessionCreateResponseEventArgs & > >	GetCreateResponseEvent ()=0
	Sessionが作成されたときに呼び出されるコールバックイベントを取得します。 [詳解]

virtual std::shared_ptr< IDiarkisEvent< const DiarkisSessionInviteEventArgs & > >	GetInviteEvent ()=0
	セッション招待を受け取るためのコールバックイベントを取得します。 [詳解]

virtual std::shared_ptr< IDiarkisEvent< const DiarkisSessionNotificationEventArgs & > >	GetJoinEvent ()=0
	別のメンバーがセッションに参加した際に呼ばれるコールバックイベントを取得します。 [詳解]

virtual std::shared_ptr< IDiarkisEvent< const DiarkisSessionNotificationEventArgs & > >	GetBroadcastEvent ()=0
	ブロードキャストメッセージを受信したときに呼び出されるコールバックイベントを取得します。 [詳解]

virtual std::shared_ptr< IDiarkisEvent< const DiarkisSessionNotificationEventArgs & > >	GetMessageToEvent ()=0
	メッセージToを受信したときに呼び出されるコールバックイベントを取得します。 [詳解]

virtual std::shared_ptr< IDiarkisEvent< const DiarkisSessionNotificationEventArgs & > >	GetLeaveEvent ()=0
	メンバーがセッションから退出したときに呼び出されるコールバックイベントを取得します。 [詳解]

virtual std::shared_ptr< IDiarkisEvent< const DiarkisSessionInfoEventArgs & > >	GetSessionInfoEvent ()=0
	セッション情報の応答を受信したときに呼び出されます。 [詳解]

virtual std::shared_ptr< IDiarkisEvent< const DiarkisSessionNotificationEventArgs & > >	GetKickEvent ()=0
	セッションキック時にサーバーからのプッシュを受信するコールバックイベントを取得します。 [詳解]

virtual std::shared_ptr< IDiarkisEvent< const DiarkisSessionResponseEventArgs & > >	GetInviteResponseEvent ()=0
	セッション招待に対するサーバーからのレスポンスを受信したときのコールバックイベントを取得します。 [詳解]

virtual std::shared_ptr< IDiarkisEvent< const DiarkisSessionResponseEventArgs & > >	GetKickResponseEvent ()=0
	セッションキックへのサーバーからのレスポンスを受信した際のコールバックイベントを取得します。 [詳解]

virtual std::shared_ptr< IDiarkisEvent< const DiarkisSessionResponseEventArgs & > >	GetJoinResponseEvent ()=0
	セッションに参加するためのサーバーからのレスポンスを受信したときのコールバックイベントを取得します。 [詳解]

virtual std::shared_ptr< IDiarkisEvent< const DiarkisSessionResponseEventArgs & > >	GetBroadcastResponseEvent ()=0
	サーバーがブロードキャストに応答したときにコールバックイベントを取得する。 [詳解]

virtual std::shared_ptr< IDiarkisEvent< const DiarkisSessionResponseEventArgs & > >	GetMessageToResponseEvent ()=0
	MessageToに対するサーバーの応答を受信した際のコールバックイベントを取得します。 [詳解]

virtual std::shared_ptr< IDiarkisEvent< const DiarkisSessionResponseEventArgs & > >	GetLeaveResponseEvent ()=0
	Leave が受信されたときにサーバーからのコールバックイベントを取得します。 [詳解]

virtual Diarkis::System::Result	SendCreate (uint8_t sessionType, uint8_t maxMembers, uint8_t ttl)=0
	新しいセッションを作成します。 [詳解]

virtual Diarkis::System::Result	SendInvite (const char **uids, size_t uidsCount, uint8_t sessionType)=0
	ユーザーを現在参加しているSessionに招待します。 [詳解]

virtual Diarkis::System::Result	SendInvite (const Diarkis::StdVector< Diarkis::StdString > &uids, uint8_t sessionType)=0
	SendInvite(const char**, size_t, uint8_t)と同じです [詳解]

virtual Diarkis::System::Result	SendInvite (const char *uids, size_t uidsCount, uint8_t sessionType, const uint8_t message, size_t messageSize)=0
	ユーザーを現在いるRoomに招待します。 [詳解]

virtual Diarkis::System::Result	SendInvite (const Diarkis::StdVector< Diarkis::StdString > &uids, uint8_t sessionType, const Diarkis::StdVector< uint8_t > &message)=0
	SendInvite(const char*, size_t, uint8_t, const uint8_t, size_t)と同じです [詳解]

virtual Diarkis::System::Result	SendBroadcast (uint8_t sessionType, const uint8_t *message, size_t messageSize)=0
	メッセージをブロードキャストする [詳解]

virtual Diarkis::System::Result	SendBroadcast (uint8_t sessionType, const Diarkis::StdVector< uint8_t > &message)=0
	SendBroadcast()と同じです [詳解]

virtual Diarkis::System::Result	SendMessageTo (uint8_t sessionType, const char *uids, size_t uidsCount, const uint8_t message, size_t messageSize)=0
	特定のメンバーにメッセージを送信します [詳解]

virtual Diarkis::System::Result	SendMessageTo (uint8_t sessionType, const Diarkis::StdVector< Diarkis::StdString > &memberIDs, const Diarkis::StdVector< uint8_t > &message)=0
	SendMessageTo()と同じです [詳解]

virtual Diarkis::System::Result	SendJoin (uint8_t sessionType, const char *sessionID)=0
	セッションに参加する [詳解]

virtual Diarkis::System::Result	SendJoin (uint8_t sessionType, const Diarkis::StdString &sessionID)=0
	SendJoin()と同じ [詳解]

virtual Diarkis::System::Result	SendLeave (uint8_t sessionType)=0
	セッションを離れる [詳解]

virtual Diarkis::System::Result	SendKick (uint8_t sessionType, const Diarkis::StdString &userID)=0
	セッションメンバーをキックする [詳解]

virtual Diarkis::System::Result	SendKick (uint8_t sessionType, const char *userID)=0
	SendKick()と同じです [詳解]

virtual Diarkis::System::Result	SendGetSessionInfoBySessionType (uint8_t sessionType)=0
	OnSessionInfo イベントを発生させ、Session の情報を取得します。 [詳解]

virtual Diarkis::System::Result	SendGetSessionInfoBySessionID (const char *sessionID)=0
	OnSessionInfo イベントを発生させ、Session の情報を取得します。 [詳解]

virtual Diarkis::System::Result	SendGetSessionInfoBySessionID (const Diarkis::StdString &sessionID)=0
	SendGetSessionInfoBySessionID()と同じです [詳解]

virtual Diarkis::StdString	GetSessionIDByType (uint8_t sessionType) const =0
	参加しているセッションのセッションIDを取得します。 [詳解]

virtual bool	HasSession (uint8_t sessionType) const =0
	少なくとも1つのSessionに参加しているかどうかをチェックします。 [詳解]

virtual void	SetUID (const char *userID)=0
	ユーザーIDを設定する [詳解]

virtual void	SetUID (const Diarkis::StdString &userID)=0
	SetUID()と同じです [詳解]

virtual Diarkis::StdString	GetUID () const =0
	ユーザーIDを取得する [詳解]

詳解

Session機能のためのインターフェースクラス

構築子と解体子

◆ ~IDiarkisSession()

virtual Diarkis::Modules::IDiarkisSession::~IDiarkisSession ( )

inlinevirtual

IDiarkisSessionのデストラクタ

関数詳解

◆ SetLoggerFactory()

virtual void Diarkis::Modules::IDiarkisSession::SetLoggerFactory	(	const std::shared_ptr< IDiarkisLoggerFactory > &	loggerFactory,
		const Diarkis::StdString &	loggerNameSuffix
	)

pure virtual

ロガーを登録します。

引数

[in]	loggerFactory	IDiarkisLoggerFactoryへのポインタ
[in]	loggerNameSuffix	ログに出力されるタグに追加される文字列

◆ SetupAsTcp()

virtual bool Diarkis::Modules::IDiarkisSession::SetupAsTcp ( std::shared_ptr< IDiarkisTcp > tcp )

pure virtual

SessionをTCPプロトコルとして設定します。

◆ SetupAsUdp()

virtual bool Diarkis::Modules::IDiarkisSession::SetupAsUdp ( std::shared_ptr< IDiarkisUdp > udp )

pure virtual

UDPプロトコルを使用したセッションの設定。

◆ SetTcp()

virtual bool Diarkis::Modules::IDiarkisSession::SetTcp ( std::shared_ptr< IDiarkisTcp > tcp )

pure virtual

IDiarkisTcpクラスを設定します

◆ SetUdp()

virtual bool Diarkis::Modules::IDiarkisSession::SetUdp ( std::shared_ptr< IDiarkisUdp > udp )

pure virtual

IDiarkisUdpクラスを設定します

◆ GetCreateResponseEvent()

virtual std::shared_ptr<IDiarkisEvent<const DiarkisSessionCreateResponseEventArgs&> > Diarkis::Modules::IDiarkisSession::GetCreateResponseEvent ( )

pure virtual

Sessionが作成されたときに呼び出されるコールバックイベントを取得します。

Session Createの応答を受信したときに呼び出されます。
イベントの内容はSession IDです。このユーザーは自動的にセッションの所有者です。

◆ GetInviteEvent()

virtual std::shared_ptr<IDiarkisEvent<const DiarkisSessionInviteEventArgs&> > Diarkis::Modules::IDiarkisSession::GetInviteEvent ( )

pure virtual

セッション招待を受け取るためのコールバックイベントを取得します。

セッション招待を受け取ったときにサーバーからプッシュされるイベントです。
イベントの内容は、セッションIDと招待者が書いたメッセージです。

◆ GetJoinEvent()

virtual std::shared_ptr<IDiarkisEvent<const DiarkisSessionNotificationEventArgs&> > Diarkis::Modules::IDiarkisSession::GetJoinEvent ( )

pure virtual

別のメンバーがセッションに参加した際に呼ばれるコールバックイベントを取得します。

別のメンバーがセッションに参加した際にサーバーから送られるイベントです。イベントには新しいメンバーのユーザーIDが含まれます。

◆ GetBroadcastEvent()

virtual std::shared_ptr<IDiarkisEvent<const DiarkisSessionNotificationEventArgs&> > Diarkis::Modules::IDiarkisSession::GetBroadcastEvent ( )

pure virtual

ブロードキャストメッセージを受信したときに呼び出されるコールバックイベントを取得します。

セッション内の参加者がブロードキャスト経由でメッセージを送信したときにサーバーからプッシュされるイベントです。

◆ GetMessageToEvent()

virtual std::shared_ptr<IDiarkisEvent<const DiarkisSessionNotificationEventArgs&> > Diarkis::Modules::IDiarkisSession::GetMessageToEvent ( )

pure virtual

メッセージToを受信したときに呼び出されるコールバックイベントを取得します。

セッションの参加者がMessageToでメッセージを送信すると、サーバーからプッシュされるイベントです。

◆ GetLeaveEvent()

virtual std::shared_ptr<IDiarkisEvent<const DiarkisSessionNotificationEventArgs&> > Diarkis::Modules::IDiarkisSession::GetLeaveEvent ( )

pure virtual

メンバーがセッションから退出したときに呼び出されるコールバックイベントを取得します。

サーバーからプッシュされたイベントは、メンバーがセッションから退出したとき（サーバーとの通信が途切れた場合も含む）に呼び出されます。イベントの内容は、部屋を退出したメンバーのユーザーIDです。

◆ GetSessionInfoEvent()

virtual std::shared_ptr<IDiarkisEvent<const DiarkisSessionInfoEventArgs&> > Diarkis::Modules::IDiarkisSession::GetSessionInfoEvent ( )

pure virtual

セッション情報の応答を受信したときに呼び出されます。

◆ GetKickEvent()

virtual std::shared_ptr<IDiarkisEvent<const DiarkisSessionNotificationEventArgs&> > Diarkis::Modules::IDiarkisSession::GetKickEvent ( )

pure virtual

セッションキック時にサーバーからのプッシュを受信するコールバックイベントを取得します。

◆ GetInviteResponseEvent()

virtual std::shared_ptr<IDiarkisEvent<const DiarkisSessionResponseEventArgs&> > Diarkis::Modules::IDiarkisSession::GetInviteResponseEvent ( )

pure virtual

セッション招待に対するサーバーからのレスポンスを受信したときのコールバックイベントを取得します。

◆ GetKickResponseEvent()

virtual std::shared_ptr<IDiarkisEvent<const DiarkisSessionResponseEventArgs&> > Diarkis::Modules::IDiarkisSession::GetKickResponseEvent ( )

pure virtual

セッションキックへのサーバーからのレスポンスを受信した際のコールバックイベントを取得します。

◆ GetJoinResponseEvent()

virtual std::shared_ptr<IDiarkisEvent<const DiarkisSessionResponseEventArgs&> > Diarkis::Modules::IDiarkisSession::GetJoinResponseEvent ( )

pure virtual

セッションに参加するためのサーバーからのレスポンスを受信したときのコールバックイベントを取得します。

◆ GetBroadcastResponseEvent()

virtual std::shared_ptr<IDiarkisEvent<const DiarkisSessionResponseEventArgs&> > Diarkis::Modules::IDiarkisSession::GetBroadcastResponseEvent ( )

pure virtual

サーバーがブロードキャストに応答したときにコールバックイベントを取得する。

◆ GetMessageToResponseEvent()

virtual std::shared_ptr<IDiarkisEvent<const DiarkisSessionResponseEventArgs&> > Diarkis::Modules::IDiarkisSession::GetMessageToResponseEvent ( )

pure virtual

MessageToに対するサーバーの応答を受信した際のコールバックイベントを取得します。

◆ GetLeaveResponseEvent()

virtual std::shared_ptr<IDiarkisEvent<const DiarkisSessionResponseEventArgs&> > Diarkis::Modules::IDiarkisSession::GetLeaveResponseEvent ( )

pure virtual

Leave が受信されたときにサーバーからのコールバックイベントを取得します。

◆ SendCreate()

virtual Diarkis::System::Result Diarkis::Modules::IDiarkisSession::SendCreate	(	uint8_t	sessionType,
		uint8_t	maxMembers,
		uint8_t	ttl
	)

pure virtual

新しいセッションを作成します。

GetCreateEvent() で登録されたコールバックイベント（例：OnSessionCreate）がトリガーされます。

引数

[in]	sessionType	セッションタイプ
[in]	maxMembers	セッション内の参加者の最大数
[in]	ttl	空の状態からセッションが持続する時間（秒単位）

◆ SendInvite() [1/4]

virtual Diarkis::System::Result Diarkis::Modules::IDiarkisSession::SendInvite	(	const char **	uids,
		size_t	uidsCount,
		uint8_t	sessionType
	)

pure virtual

ユーザーを現在参加しているSessionに招待します。

OnSessionInviteは招待されたユーザーによってトリガーされます。

引数

[in]	uids	招待状を送信するユーザーIDのリスト
[in]	uidsCount	ユーザーIDの数
[in]	sessionType	招待するSessionのタイプ。

◆ SendInvite() [2/4]

virtual Diarkis::System::Result Diarkis::Modules::IDiarkisSession::SendInvite	(	const Diarkis::StdVector< Diarkis::StdString > &	uids,
		uint8_t	sessionType
	)

pure virtual

SendInvite(const char**, size_t, uint8_t)と同じです

◆ SendInvite() [3/4]

virtual Diarkis::System::Result Diarkis::Modules::IDiarkisSession::SendInvite	(	const char **	uids,
		size_t	uidsCount,
		uint8_t	sessionType,
		const uint8_t *	message,
		size_t	messageSize
	)

pure virtual

ユーザーを現在いるRoomに招待します。

OnSessionInviteは招待されたユーザーによってトリガーされます。

引数

[in]	uids	招待するユーザーIDのリスト
[in]	uidsCount	ユーザーIDの数
[in]	sessionType	招待するSessionのタイプ
[in]	message	送信するメッセージ
[in]	messageSize	メッセージの長さ

◆ SendInvite() [4/4]

virtual Diarkis::System::Result Diarkis::Modules::IDiarkisSession::SendInvite	(	const Diarkis::StdVector< Diarkis::StdString > &	uids,
		uint8_t	sessionType,
		const Diarkis::StdVector< uint8_t > &	message
	)

pure virtual

SendInvite(const char**, size_t, uint8_t, const uint8_t*, size_t)と同じです

◆ SendBroadcast() [1/2]

virtual Diarkis::System::Result Diarkis::Modules::IDiarkisSession::SendBroadcast	(	uint8_t	sessionType,
		const uint8_t *	message,
		size_t	messageSize
	)

pure virtual

メッセージをブロードキャストする

メッセージは、自分を含むセッションのすべてのメンバーに配信されます。

引数

[in]	sessionType	セッションの種類
[in]	message	送信するメッセージ
[in]	messageSize	メッセージの長さ

◆ SendBroadcast() [2/2]

virtual Diarkis::System::Result Diarkis::Modules::IDiarkisSession::SendBroadcast	(	uint8_t	sessionType,
		const Diarkis::StdVector< uint8_t > &	message
	)

pure virtual

SendBroadcast()と同じです

◆ SendMessageTo() [1/2]

virtual Diarkis::System::Result Diarkis::Modules::IDiarkisSession::SendMessageTo	(	uint8_t	sessionType,
		const char **	uids,
		size_t	uidsCount,
		const uint8_t *	message,
		size_t	messageSize
	)

pure virtual

特定のメンバーにメッセージを送信します

メッセージはSessionの特定のメンバーに配信されます。

引数

[in]	sessionType	セッションの種類
[in]	uids	メッセージを送信するユーザーIDのリスト
[in]	uidsCount	ユーザーIDの数
[in]	message	ペイロードデータ
[in]	messageSize	メッセージの長さ

◆ SendMessageTo() [2/2]

virtual Diarkis::System::Result Diarkis::Modules::IDiarkisSession::SendMessageTo	(	uint8_t	sessionType,
		const Diarkis::StdVector< Diarkis::StdString > &	memberIDs,
		const Diarkis::StdVector< uint8_t > &	message
	)

pure virtual

SendMessageTo()と同じです

◆ SendJoin() [1/2]

virtual Diarkis::System::Result Diarkis::Modules::IDiarkisSession::SendJoin	(	uint8_t	sessionType,
		const char *	sessionID
	)

pure virtual

セッションに参加する

引数

[in]	sessionType	セッションタイプ
[in]	sessionID	セッションID

◆ SendJoin() [2/2]

virtual Diarkis::System::Result Diarkis::Modules::IDiarkisSession::SendJoin	(	uint8_t	sessionType,
		const Diarkis::StdString &	sessionID
	)

pure virtual

SendJoin()と同じ

◆ SendLeave()

virtual Diarkis::System::Result Diarkis::Modules::IDiarkisSession::SendLeave ( uint8_t sessionType )

pure virtual

セッションを離れる

引数

[in] sessionType セッションタイプ

◆ SendKick() [1/2]

virtual Diarkis::System::Result Diarkis::Modules::IDiarkisSession::SendKick	(	uint8_t	sessionType,
		const Diarkis::StdString &	userID
	)

pure virtual

セッションメンバーをキックする

引数

[in]	sessionType	セッションタイプ
[in]	userID	キックするユーザーのID

◆ SendKick() [2/2]

virtual Diarkis::System::Result Diarkis::Modules::IDiarkisSession::SendKick	(	uint8_t	sessionType,
		const char *	userID
	)

pure virtual

SendKick()と同じです

◆ SendGetSessionInfoBySessionType()

virtual Diarkis::System::Result Diarkis::Modules::IDiarkisSession::SendGetSessionInfoBySessionType ( uint8_t sessionType )

pure virtual

OnSessionInfo イベントを発生させ、Session の情報を取得します。

引数

[in] sessionType Session タイプ

◆ SendGetSessionInfoBySessionID() [1/2]

virtual Diarkis::System::Result Diarkis::Modules::IDiarkisSession::SendGetSessionInfoBySessionID ( const char * sessionID )

pure virtual

OnSessionInfo イベントを発生させ、Session の情報を取得します。

引数

[in] sessionID Session ID

◆ SendGetSessionInfoBySessionID() [2/2]

virtual Diarkis::System::Result Diarkis::Modules::IDiarkisSession::SendGetSessionInfoBySessionID ( const Diarkis::StdString & sessionID )

pure virtual

SendGetSessionInfoBySessionID()と同じです

◆ GetSessionIDByType()

virtual Diarkis::StdString Diarkis::Modules::IDiarkisSession::GetSessionIDByType ( uint8_t sessionType ) const

pure virtual

参加しているセッションのセッションIDを取得します。

セッションに参加していない場合は空の文字列が返されます。

引数

[in] sessionType セッションの種類

◆ HasSession()

virtual bool Diarkis::Modules::IDiarkisSession::HasSession ( uint8_t sessionType ) const

pure virtual

少なくとも1つのSessionに参加しているかどうかをチェックします。

◆ SetUID() [1/2]

virtual void Diarkis::Modules::IDiarkisSession::SetUID ( const char * userID )

pure virtual

ユーザーIDを設定する

引数

[in] userID ユーザーID

◆ SetUID() [2/2]

virtual void Diarkis::Modules::IDiarkisSession::SetUID ( const Diarkis::StdString & userID )

pure virtual

SetUID()と同じです

◆ GetUID()

virtual Diarkis::StdString Diarkis::Modules::IDiarkisSession::GetUID ( ) const

pure virtual

ユーザーIDを取得する

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

client/cpp/libDiarkis/include/diarkis/modules/session.h

公開メンバ関数

詳解

構築子と解体子

◆ ~IDiarkisSession()

関数詳解

◆ SetLoggerFactory()

◆ SetupAsTcp()

◆ SetupAsUdp()

◆ SetTcp()

◆ SetUdp()

◆ GetCreateResponseEvent()

◆ GetInviteEvent()

◆ GetJoinEvent()

◆ GetBroadcastEvent()

◆ GetMessageToEvent()

◆ GetLeaveEvent()

◆ GetSessionInfoEvent()

◆ GetKickEvent()

◆ GetInviteResponseEvent()

◆ GetKickResponseEvent()

◆ GetJoinResponseEvent()

◆ GetBroadcastResponseEvent()

◆ GetMessageToResponseEvent()

◆ GetLeaveResponseEvent()

◆ SendCreate()

◆ SendInvite() [1/4]

◆ SendInvite() [2/4]

◆ SendInvite() [3/4]

◆ SendInvite() [4/4]

◆ SendBroadcast() [1/2]

◆ SendBroadcast() [2/2]

◆ SendMessageTo() [1/2]

◆ SendMessageTo() [2/2]

◆ SendJoin() [1/2]

◆ SendJoin() [2/2]

◆ SendLeave()

◆ SendKick() [1/2]

◆ SendKick() [2/2]

◆ SendGetSessionInfoBySessionType()

◆ SendGetSessionInfoBySessionID() [1/2]

◆ SendGetSessionInfoBySessionID() [2/2]

◆ GetSessionIDByType()

◆ HasSession()

◆ SetUID() [1/2]

◆ SetUID() [2/2]

◆ GetUID()