NetworkMgr::GetReliableResendTime

Defined in: C4Network.h

Returns the time interval between reliable packet transmission attempts.

Prototype

uint32 GetReliableResendTime(void) const;

Description

When the Network Manager sends a reliable packet, it waits for a return receipt, or acknowledgement, from the receiving machine that confirms the packet's arrival at its destination. If an acknowledgement has not been received after a certain time period, the packet is retransmitted. The Network Manager makes a certain number of attempts before a connection is considered to have timed out. The GetReliableResendTime function returns the time interval between attempts to send a reliable packet, in milliseconds. This time can be changed by calling NetworkMgr::SetReliableResendTime.

When a connection times out, the Network Manager calls the currently installed network event procedure, if any, and then disconnects from the machine that timed out. The low-level network event procedure can be set using the NetworkMgr::SetNetworkEventCallback function, but this procedure should not be changed if the Message Manager is being used. Instead, the Message Manager will call the Application::HandleConnectionEvent function when a connection times out.