Diarkis::Network Namespace Reference

Namespaces
	Types

Classes
class	IDiarkisProfile
class	IDiarkisTcp
	Interface class for TCP function. More...
class	IDiarkisTransport
class	IDiarkisUdp
	Interface class for UDP function. More...

Enumerations
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 }
	Protocol type. More...
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 }
	Reason for disconnection from UDP server. More...

Functions
DIARKIS_EXPORT std::ostream &	operator<< (std::ostream &, DiarkisTcpConnectionState)
DIARKIS_EXPORT IDiarkisTcp *	DiarkisCreateTcp (size_t heartbeatInterval=5000)
	Create IDiarkisTcp class. More...
DIARKIS_EXPORT std::ostream &	operator<< (std::ostream &os, const DiarkisTransportType type)
DIARKIS_EXPORT std::ostream &	operator<< (std::ostream &, DiarkisUdpDisconnectionReason)
DIARKIS_EXPORT IDiarkisUdp *	DiarkisCreateUdp (uint32_t sendInterval=100, uint32_t echoInterval=5000)
	Initialization of UDP class instance. More...

Variables
enum DIARKIS_EXPORT	DiarkisTcpConnectionState
enum DIARKIS_EXPORT	DiarkisUdpDisconnectionReason

Enumeration Type Documentation

DiarkisTcpConnectionState

enum Diarkis::Network::DiarkisTcpConnectionState : std::uint8_t

strong

Enumerator
NOT_CONNECTED
CONNECTING
CONNECTED
DISCONNECTING
BROKEN

DiarkisTransportType

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

strong

Protocol type.

Enumerator
TCP	TCP protocol.
UDP	UDP protocol.

DiarkisUdpDisconnectionReason

enum Diarkis::Network::DiarkisUdpDisconnectionReason : std::uint8_t

strong

Reason for disconnection from UDP server.

Enumerator
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.

Function Documentation

operator<<() [1/3]

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

DiarkisCreateTcp()

DIARKIS_EXPORT IDiarkisTcp* Diarkis::Network::DiarkisCreateTcp

(

size_t

heartbeatInterval = 5000

)

Create IDiarkisTcp class.

Here is the caller graph for this function:

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
	)

Initialization of UDP class instance.

Parameters

[in]	sendInterval	Maximum sleep time (ms) of the thread for sending packets. Minimum time that can be set is 10 ms.
[in]	echoInterval	Interval between sending echoes (ms) default value 5 sec.

Returns

IDiarkisUdp pointer

Here is the caller graph for this function:

Variable Documentation

DiarkisTcpConnectionState

enum DIARKIS_EXPORT Diarkis::Network::DiarkisTcpConnectionState

strong

DiarkisUdpDisconnectionReason

enum DIARKIS_EXPORT Diarkis::Network::DiarkisUdpDisconnectionReason

strong