Diarkis C++Client Library API Document
公開メンバ関数 | 全メンバ一覧
Diarkis::Modules::IDiarkisField クラスabstract

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

#include <field.h>

公開メンバ関数

virtual ~IDiarkisField ()
 IDiarkisField クラスのデストラクタ [詳解]
 
virtual void SetLoggerFactory (std::shared_ptr< IDiarkisLoggerFactory > loggerFactory, Diarkis::StdString loggerNameSuffix)=0
 ロガーを登録します。 [詳解]
 
virtual bool SetupAsTcp (const std::shared_ptr< IDiarkisTcp > &tcp)=0
 TCPプロトコルとしてIDiarkisFieldを初期化します。 [詳解]
 
virtual bool SetupAsUdp (const std::shared_ptr< IDiarkisUdp > &udp)=0
 UDPプロトコルとしてIDiarkisFieldを初期化します。 [詳解]
 
virtual Diarkis::System::Result Disappear ()=0
 FieldをUDPプロトコルとして設定します。 [詳解]
 
virtual Diarkis::System::Result Leave ()=0
 Fieldを退出することを通知します。 [詳解]
 
virtual Diarkis::System::Result Join (int64_t x, int64_t y, int64_t z, uint16_t syncLimit, uint8_t customFilterID, const uint8_t *message, size_t messageSize, bool reliable=false)=0
 フィールドに参加します。 [詳解]
 
virtual Diarkis::System::Result Join (int64_t x, int64_t y, int64_t z, uint16_t syncLimit, uint8_t customFilterID, const Diarkis::StdVector< uint8_t > &message, bool reliable=false)=0
 Join()と同じです [詳解]
 
virtual Diarkis::System::Result Sync (int64_t x, int64_t y, int64_t z, uint16_t syncLimit, uint8_t customFilterID, const uint8_t *message, size_t messageSize, bool reliable=true)=0
 Field内の他のクライアントにデータを送信します。 [詳解]
 
virtual Diarkis::System::Result Sync (int64_t x, int64_t y, int64_t z, uint16_t syncLimit, uint8_t customFilterID, const Diarkis::StdVector< uint8_t > &message, bool reliable=true)=0
 Sync()と同じです [詳解]
 
virtual std::shared_ptr< IDiarkisEvent< const Diarkis::StdVector< Diarkis::StdVector< uint8_t > > & > > GetResponseSyncInitEvent ()=0
 別のクライアントが最初にFieldに同期する際に通知を受けるために呼び出されるコールバックイベントを取得します。 [詳解]
 
virtual std::shared_ptr< IDiarkisEvent< const DiarkisSuccessEventArgs & > > GetJoinEvent ()=0
 ユーザーがFieldに参加したときの応答イベントを取得します。 [詳解]
 
virtual std::shared_ptr< IDiarkisEvent< const Diarkis::StdVector< uint8_t > & > > GetSyncEvent ()=0
 フィールド内の近くのクライアントの位置を同期する際に呼び出されるコールバックイベントを取得します。 [詳解]
 
virtual std::shared_ptr< IDiarkisEvent< const Diarkis::StdString & > > GetDisappearEvent ()=0
 他のクライアントがFieldから消えるときに呼び出されるコールバックイベントを取得します。 [詳解]
 
virtual std::shared_ptr< IDiarkisEvent< void * > > GetReconnectEvent ()=0
 Fieldが再接続されたときに呼び出されるコールバックイベントを取得します。 [詳解]
 
virtual std::shared_ptr< IDiarkisEvent< const DiarkisSuccessEventArgs & > > GetLeaveEvent ()=0
 フィールドから退出するときの応答イベントを取得します。 [詳解]
 

詳解

Fieldのためのインターフェースクラス

構築子と解体子

◆ ~IDiarkisField()

virtual Diarkis::Modules::IDiarkisField::~IDiarkisField ( )
inlinevirtual

IDiarkisField クラスのデストラクタ

関数詳解

◆ SetLoggerFactory()

virtual void Diarkis::Modules::IDiarkisField::SetLoggerFactory ( std::shared_ptr< IDiarkisLoggerFactory >  loggerFactory,
Diarkis::StdString  loggerNameSuffix 
)
pure virtual

ロガーを登録します。

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

◆ SetupAsTcp()

virtual bool Diarkis::Modules::IDiarkisField::SetupAsTcp ( const std::shared_ptr< IDiarkisTcp > &  tcp)
pure virtual

TCPプロトコルとしてIDiarkisFieldを初期化します。

◆ SetupAsUdp()

virtual bool Diarkis::Modules::IDiarkisField::SetupAsUdp ( const std::shared_ptr< IDiarkisUdp > &  udp)
pure virtual

UDPプロトコルとしてIDiarkisFieldを初期化します。

◆ Disappear()

virtual Diarkis::System::Result Diarkis::Modules::IDiarkisField::Disappear ( )
pure virtual

FieldをUDPプロトコルとして設定します。

◆ Leave()

virtual Diarkis::System::Result Diarkis::Modules::IDiarkisField::Leave ( )
pure virtual

Fieldを退出することを通知します。

◆ Join() [1/2]

virtual Diarkis::System::Result Diarkis::Modules::IDiarkisField::Join ( int64_t  x,
int64_t  y,
int64_t  z,
uint16_t  syncLimit,
uint8_t  customFilterID,
const uint8_t *  message,
size_t  messageSize,
bool  reliable = false 
)
pure virtual

フィールドに参加します。

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

引数
[in]xフィールド内のX座標の値（幅）
[in]yフィールド内のY座標の値（奥行き）
[in]zフィールド内のZ座標の値（高さではなく空間レベルの差）
[in]syncLimit同期の回数
[in]customFilterID同期中にサーバーで定義されたフィルター関数の使用を示します。0 はフィルター関数が使用されていないことを示します。
[in]message他のクライアントに送信するデータの配列
[in]messageSizeメッセージの長さ
[in]reliable信頼性のある通信（RUDP）を介して送信するかどうかを決定します。TCPプロトコルでは無視されます。

◆ Join() [2/2]

virtual Diarkis::System::Result Diarkis::Modules::IDiarkisField::Join ( int64_t  x,
int64_t  y,
int64_t  z,
uint16_t  syncLimit,
uint8_t  customFilterID,
const Diarkis::StdVector< uint8_t > &  message,
bool  reliable = false 
)
pure virtual

Join()と同じです

◆ Sync() [1/2]

virtual Diarkis::System::Result Diarkis::Modules::IDiarkisField::Sync ( int64_t  x,
int64_t  y,
int64_t  z,
uint16_t  syncLimit,
uint8_t  customFilterID,
const uint8_t *  message,
size_t  messageSize,
bool  reliable = true 
)
pure virtual

Field内の他のクライアントにデータを送信します。

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

引数
[in]xField内のX座標の値（幅）
[in]yField内のY座標の値（奥行き）
[in]zField内のZ座標の値（高さではなく空間の違い）
[in]syncLimit同期の回数
[in]customFilterIDサーバーが同期中に定義したフィルター関数の使用を示します。
0はフィルター関数が使用されていないことを示します。
[in]message他のクライアントに送信するデータ
[in]messageSizeメッセージの長さ
[in]reliable信頼性のある通信（RUDP）で送信するかどうかを決定します（UDPでは無視されます）。

◆ Sync() [2/2]

virtual Diarkis::System::Result Diarkis::Modules::IDiarkisField::Sync ( int64_t  x,
int64_t  y,
int64_t  z,
uint16_t  syncLimit,
uint8_t  customFilterID,
const Diarkis::StdVector< uint8_t > &  message,
bool  reliable = true 
)
pure virtual

Sync()と同じです

◆ GetResponseSyncInitEvent()

virtual std::shared_ptr<IDiarkisEvent<const Diarkis::StdVector<Diarkis::StdVector<uint8_t> >&> > Diarkis::Modules::IDiarkisField::GetResponseSyncInitEvent ( )
pure virtual

別のクライアントが最初にFieldに同期する際に通知を受けるために呼び出されるコールバックイベントを取得します。

◆ GetJoinEvent()

virtual std::shared_ptr<IDiarkisEvent<const DiarkisSuccessEventArgs&> > Diarkis::Modules::IDiarkisField::GetJoinEvent ( )
pure virtual

ユーザーがFieldに参加したときの応答イベントを取得します。

◆ GetSyncEvent()

virtual std::shared_ptr<IDiarkisEvent<const Diarkis::StdVector<uint8_t>&> > Diarkis::Modules::IDiarkisField::GetSyncEvent ( )
pure virtual

フィールド内の近くのクライアントの位置を同期する際に呼び出されるコールバックイベントを取得します。

◆ GetDisappearEvent()

virtual std::shared_ptr<IDiarkisEvent<const Diarkis::StdString&> > Diarkis::Modules::IDiarkisField::GetDisappearEvent ( )
pure virtual

他のクライアントがFieldから消えるときに呼び出されるコールバックイベントを取得します。

◆ GetReconnectEvent()

virtual std::shared_ptr<IDiarkisEvent<void*> > Diarkis::Modules::IDiarkisField::GetReconnectEvent ( )
pure virtual

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

◆ GetLeaveEvent()

virtual std::shared_ptr<IDiarkisEvent<const DiarkisSuccessEventArgs&> > Diarkis::Modules::IDiarkisField::GetLeaveEvent ( )
pure virtual

フィールドから退出するときの応答イベントを取得します。

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