Diarkis C++Client Library API Document
Diarkis::Network 名前空間

名前空間

 Types
 

クラス

class  IDiarkisProfile
 
class  IDiarkisTcp
 TCP機能のためのインターフェースクラス [詳解]
 
class  IDiarkisTransport
 
class  IDiarkisUdp
 UDP機能のためのインターフェースクラス [詳解]
 

列挙型

enum  DiarkisTcpConnectionState : std::uint8_t {
  DiarkisTcpConnectionState::NOT_CONNECTED = 0, DiarkisTcpConnectionState::CONNECTING, DiarkisTcpConnectionState::CONNECTED, DiarkisTcpConnectionState::DISCONNECTING,
  DiarkisTcpConnectionState::BROKEN
}
 
enum  DiarkisTransportType : std::uint8_t { DiarkisTransportType::TCP = 1, DiarkisTransportType::UDP }
 プロトコルタイプ [詳解]
 
enum  DiarkisUdpDisconnectionReason : std::uint8_t {
  DiarkisUdpDisconnectionReason::Expected = 0, DiarkisUdpDisconnectionReason::NoResponse = 1, DiarkisUdpDisconnectionReason::RetryTimeout = 2, DiarkisUdpDisconnectionReason::ForcedByServer = 3,
  DiarkisUdpDisconnectionReason::Forced = 4, DiarkisUdpDisconnectionReason::Timeout = 5, DiarkisUdpDisconnectionReason::NormalDisconnect = 6
}
 UDPサーバーから切断された理由 [詳解]
 

関数

DIARKIS_EXPORT std::ostream & operator<< (std::ostream &, DiarkisTcpConnectionState)
 
DIARKIS_EXPORT IDiarkisTcpDiarkisCreateTcp (size_t heartbeatInterval=5000)
 IDiarkisTcpクラスを作成します。 [詳解]
 
DIARKIS_EXPORT std::ostream & operator<< (std::ostream &os, const DiarkisTransportType type)
 
DIARKIS_EXPORT std::ostream & operator<< (std::ostream &, DiarkisUdpDisconnectionReason)
 
DIARKIS_EXPORT IDiarkisUdpDiarkisCreateUdp (uint32_t sendInterval=100, uint32_t echoInterval=5000)
 UDPクラスインスタンスの初期化。 [詳解]
 

変数

enum DIARKIS_EXPORT DiarkisTcpConnectionState
 
enum DIARKIS_EXPORT DiarkisUdpDisconnectionReason
 

列挙型詳解

◆ DiarkisTcpConnectionState

enum Diarkis::Network::DiarkisTcpConnectionState : std::uint8_t
strong
列挙値
NOT_CONNECTED 
CONNECTING 
CONNECTED 
DISCONNECTING 
BROKEN 

◆ DiarkisTransportType

enum Diarkis::Network::DiarkisTransportType : std::uint8_t
strong

プロトコルタイプ

列挙値
TCP 

TCP protocol

UDP 

UDP protocol

◆ DiarkisUdpDisconnectionReason

UDPサーバーから切断された理由

列挙値
Expected 

Expected.

NoResponse 

No echo response from server.

RetryTimeout 

RUDP retransmission count reached limit.

ForcedByServer 

Force termination from server.

Forced 

e.g. Socket error

Timeout 

Initial connection to UDP server timed out.

NormalDisconnect 

Disconnected by the application.

関数詳解

◆ operator<<() [1/3]

DIARKIS_EXPORT std::ostream& Diarkis::Network::operator<< ( std::ostream &  ,
DiarkisTcpConnectionState   
)

◆ DiarkisCreateTcp()

DIARKIS_EXPORT IDiarkisTcp* Diarkis::Network::DiarkisCreateTcp ( size_t  heartbeatInterval = 5000)

IDiarkisTcpクラスを作成します。

被呼び出し関係図:

◆ operator<<() [2/3]

DIARKIS_EXPORT std::ostream& Diarkis::Network::operator<< ( std::ostream &  os,
const DiarkisTransportType  type 
)

◆ operator<<() [3/3]

DIARKIS_EXPORT std::ostream& Diarkis::Network::operator<< ( std::ostream &  ,
DiarkisUdpDisconnectionReason   
)

◆ DiarkisCreateUdp()

DIARKIS_EXPORT IDiarkisUdp* Diarkis::Network::DiarkisCreateUdp ( uint32_t  sendInterval = 100,
uint32_t  echoInterval = 5000 
)

UDPクラスインスタンスの初期化。

引数
[in]sendIntervalパケットを送信するスレッドの最大スリープ時間(ms)。設定できる最小時間は10msです。
[in]echoIntervalエコーを送信する間隔(ms)デフォルト値は5秒。
戻り値
IDiarkisUdp ポインタ
被呼び出し関係図:

変数詳解

◆ DiarkisTcpConnectionState

enum DIARKIS_EXPORT Diarkis::Network::DiarkisTcpConnectionState
strong

◆ DiarkisUdpDisconnectionReason