CTR NEX API Reference
nn::nex::BinaryMessage クラス

バイナリデータを格納するクラスです [詳解]

#include <RendezVous/Services/Messaging/src/Common/BinaryMessage.h>

+ nn::nex::BinaryMessage の継承関係図

公開メンバ関数

 BinaryMessage ()
 コンストラクタです
 
 BinaryMessage (const void *pBuffer, qUnsignedInt32 bufferSize)
 コンストラクタです [詳解]
 
const void * GetBufferPtr () const
 バイナリデータのバッファアドレスを取得します。 [詳解]
 
size_t GetBufferSize () const
 バイナリデータのバッファサイズを取得します。 [詳解]
 
const DateTimeGetReceptionTime () const
 メッセージの受信時刻を取得します。 [詳解]
 
GatheringID GetRecipientGatheringID () const
 メッセージの送信時に送信先としてセットされた ギャザリング ID を返します。 [詳解]
 
PrincipalID GetRecipientPrincipalID () const
 メッセージの送信時に送信先としてセットされた プリンシパル ID を返します。 [詳解]
 
IdentifierTypes::Types GetRecipientType () const
 GetRecipientPrincipalID(), GetRecipientGatheringID() どちらの関数を呼ぶ出すべきかを判断するための ID のタイプを返します。 [詳解]
 
PrincipalID GetSenderID () const
 メッセージの送信元の PrincipalID を取得します。 [詳解]
 
const StringGetSubject () const
 メッセージの Subject を取得します。 [詳解]
 
void SetBuffer (const void *pBuffer, size_t bufferSize)
 指定したバッファをコピーしてバイナリデータをセットします。 MESSAGING_BINARY_MAX_SIZE を超えるデータは、インスタントメッセージング機能では使用できません。 サーバー送信時にエラーとなります。 [詳解]
 
void SetSubject (const String &strSubject)
 メッセージの Subject をセットします。 MESSAGING_STRING_MAX_LENGTH 文字( NULL終端含まず ) を超えるテキストは、 インスタントメッセージング機能では使用できません。サーバー送信時にエラーとなります。 [詳解]
 

静的公開メンバ関数

static DataDynamicCast (Data *pData)
 Dataクラスポインタの動的キャストを行います。 [詳解]
 

詳解

バイナリデータを格納するクラスです

インスタントメッセージング機能を利用する場合は本クラス、UserMessageTextMessage のいずれかのクラスを利用してください。

構築子と解体子

nn::nex::BinaryMessage::BinaryMessage ( const void *  pBuffer,
qUnsignedInt32  bufferSize 
)

コンストラクタです

引数
[in]pBufferバッファアドレス
[in]bufferSizeバッファサイズ

関数詳解

void nn::nex::BinaryMessage::SetBuffer ( const void *  pBuffer,
size_t  bufferSize 
)

指定したバッファをコピーしてバイナリデータをセットします。 MESSAGING_BINARY_MAX_SIZE を超えるデータは、インスタントメッセージング機能では使用できません。 サーバー送信時にエラーとなります。

引数
[in]pBufferバッファアドレス
[in]bufferSizeバッファサイズ
const void* nn::nex::BinaryMessage::GetBufferPtr ( ) const

バイナリデータのバッファアドレスを取得します。

バッファ未設定の場合は、NULLが返ります。

戻り値
バッファアドレス
size_t nn::nex::BinaryMessage::GetBufferSize ( ) const

バイナリデータのバッファサイズを取得します。

バッファ未設定の場合は、0が返ります。

戻り値
バイナリサイズ
const DateTime& nn::nex::UserMessage::GetReceptionTime ( ) const
inherited

メッセージの受信時刻を取得します。

ゲームサーバーがメッセージを受信した時刻、すなわち送信元が送信した時刻を取得します。 クライアントがメッセージを受信した時刻ではないことに注意してください。

時刻は UTC でセットされています。

戻り値
ゲームサーバーがメッセージを受信した時刻
PrincipalID nn::nex::UserMessage::GetSenderID ( ) const
inherited

メッセージの送信元の PrincipalID を取得します。

戻り値
メッセージの送信元の PrincipalID
PrincipalID nn::nex::UserMessage::GetRecipientPrincipalID ( ) const
inherited

メッセージの送信時に送信先としてセットされた プリンシパル ID を返します。

GetRecipientType() が返す ID のタイプが IdentifierTypes::PIDType の場合に使用します。 MessagingClient::SendInstant() で送信された場合はプリンシパル ID が返ります。 MessagingClient::SendChat() で送信された場合は INVALID_PRINCIPALID が返ります。

戻り値
プリンシパル ID
参照
IdentifierTypes::Types, GetRecipientType()
GatheringID nn::nex::UserMessage::GetRecipientGatheringID ( ) const
inherited

メッセージの送信時に送信先としてセットされた ギャザリング ID を返します。

GetRecipientType() が返す IDのタイプ が IdentifierTypes::GIDType の場合に使用します。 MessagingClient::SendInstant() で送信された場合は INVALID_GATHERINGID が返ります。 MessagingClient::SendChat() で送信された場合は ギャザリング ID が返ります。

戻り値
ギャザリング ID
参照
IdentifierTypes::Types, GetRecipientType()
IdentifierTypes::Types nn::nex::UserMessage::GetRecipientType ( ) const
inherited

GetRecipientPrincipalID(), GetRecipientGatheringID() どちらの関数を呼ぶ出すべきかを判断するための ID のタイプを返します。

戻り値
IdentifierTypes::Types の値
参照
IdentifierTypes::Types, GetRecipientPrincipalID(), GetRecipientGatheringID()
const String& nn::nex::UserMessage::GetSubject ( ) const
inherited

メッセージの Subject を取得します。

戻り値
メッセージの Subject
void nn::nex::UserMessage::SetSubject ( const String strSubject)
inherited

メッセージの Subject をセットします。 MESSAGING_STRING_MAX_LENGTH 文字( NULL終端含まず ) を超えるテキストは、 インスタントメッセージング機能では使用できません。サーバー送信時にエラーとなります。

引数
[in]strSubjectメッセージの Subject
static Data* nn::nex::Data::DynamicCast ( Data pData)
staticinherited

Dataクラスポインタの動的キャストを行います。

本関数は、DDLコンパイラによってDDLで定義されたDataクラスの派生クラスに自動的に作成されます。

各クラスで定義された同名関数を呼び出すことで、引数で指定されたポインタを各クラスの型のポインタに動的にキャストします。 たとえば、UserMessage::DynamicCast() であれば、引数で指定したData*型のポインタをUserMessage*に動的にキャストします。 キャスト可能であれば有効なポインタを返し、キャスト不可能であればNULLを返します。

本関数による動的キャストは独自に実装しているので、RTTIを有効にする必要はありません。

引数
[in]pDataDataクラスの派生クラスのポインタを指定します。
戻り値
pDataで指定したポインタを、呼び出し時のクラスのポインタとして返します。
戻り値一覧:
NULL pDataで指定されたポインタが、呼び出し時のクラスの派生クラスでない場合に返ります。 たとえば、UserMessage::DynamicCast() を呼び出したときに、pDataの実体がUserMessageの派生クラスでなければNULLが返ります。