 |
Diarkis C++Client Library API Document
|
Go to the documentation of this file.
15 #define DIARKIS_TCP_DEFAULT_HEARTBEAT_INTERVAL 5000
17 #if defined(__GNUC__) && !defined(__clang__)
18 #pragma GCC diagnostic push
19 #pragma GCC diagnostic ignored "-Wattributes"
37 #if defined(__GNUC__) && !defined(__clang__)
38 #pragma GCC diagnostic pop
126 int32_t perConnectionTimeoutMs) = 0;
142 int32_t perConnectionTimeoutMs) = 0;
Definition: transport.h:37
virtual Diarkis::System::Result SendHeartbeat()=0
Sends a heartbeat to the.
virtual const Diarkis::StdString & GetRoomID()=0
virtual Diarkis::System::Result Send(uint8_t version, uint16_t command, const uint8_t *payload, size_t payloadSize)=0
Send command to TCP server.
virtual Diarkis::StdString GetLocalAddress()=0
Get local IP address.
@ NOT_CONNECTED
Before connection.
Definition: protocol.h:48
virtual void SetRoomID(const Diarkis::StdString &id)=0
Contains information about a specific result value. Can be compared against another Result structure....
Definition: result.h:37
DIARKIS_EXPORT std::ostream & operator<<(std::ostream &, DiarkisTcpConnectionState)
DIARKIS_EXPORT IDiarkisTcp * DiarkisCreateTcp(size_t heartbeatInterval=5000)
Create IDiarkisTcp class.
virtual Diarkis::System::Result Connect(const Diarkis::StdString &unresolvedAddress, uint16_t port, int32_t perConnectionTimeoutMs)=0
Connect to TCP server.
virtual Diarkis::System::Result RSend(uint8_t version, uint16_t command, const uint8_t *payload, size_t payloadSize)=0
Send command to TCP server.
virtual Diarkis::System::Result SetNoDelay(bool noDelay)=0
Sets the TCP_NODELAY option on the socket.
virtual Diarkis::System::Result ConnectDualMode(const Diarkis::StdString &unresolvedAddress, uint16_t port, int32_t perConnectionTimeoutMs)=0
Attemps to connect to the server using socket dual mode (explicit support for IPv6).
virtual Diarkis::System::Result Connect(const Diarkis::StdString &unresolvedAddress, uint16_t port, uint16_t timeOut=3000)=0
Connect with the server.
virtual std::shared_ptr< IDiarkisEvent< const DiarkisTcpConnectionStateChangedEventArgs & > > GetConnectionStateChangedEvent()=0
Get the callback event called when connection state has changed.
Interface class for TCP function.
Definition: tcp.h:49
virtual DiarkisTcpConnectionState GetState() const =0
Get TCP connection status.
DiarkisTcpConnectionState
Definition: tcp.h:29
virtual std::shared_ptr< IDiarkisEvent< void * > > GetHeartbeatEvent()=0
Get the callback event called when receiving heartbeat from server.
virtual Diarkis::System::Result Migrate()=0
Attempts to change the current connection to a differernt server.
virtual ~IDiarkisTcp()
Destructor of IDiarkisTcp.
Definition: tcp.h:58
virtual Diarkis::System::Result ConnectDualMode(const Diarkis::StdString &unresolvedAddress, uint16_t port, uint16_t timeOut=3000)=0
Attemps to connect to the server using socket dual mode (explicit support for IPv6) turned on....
virtual Diarkis::System::Result SetHeartbeatInterval(size_t heartbeatInterval)=0
Sets the interval for sending heartbeats.