SendKeepAlive Method

Sends a keep alive packet to the specified client.

Syntax

[VB.NET]
Public Sub SendKeepAlive(ByVal ConnectionId As String)

[C#]
public void SendKeepAlive(string connectionId);

Remarks

This method may be used to send a keepalive packet at any time to determine if the remote host is responsive. The component will send keepalive packets periodically if KeepAlive is set to True, however this method may be used an alternative to explicitly send a keepalive packet at any time.

If Timeout is set to a positive value this method will not return until an acknowledgement is received, indicating the connection is still alive. If Timeout expires the component throws an exception. If Timeout is set to 0 the operation will return immediately and DoEvents may be called in a loop to process any timeouts.