DANSrvAE Reference
SetKeepAlive Method
See Also  Send comments on this topic.
NSPlugin Assembly > NSPlugin Namespace > EventSubscription Class : SetKeepAlive Method

_keepAliveTime
The maximum amount of time (in milliseconds) the client expects to receive a new subscription callback since the last subscription callback. A value of zero indicates the client does not wish to receive any keep-alive callbacks.
revisedKeepAliveTime
The KeepAliveTime the server is actually providing, which may differ from keepAliveTime.

Glossary Item Box

Clients can set the keep-alive time for a subscription to cause the server to provide client callbacks on the subscription when there are no new events to report. Clients can then be assured of the health of the server and subscription without resorting to pinging the server with calls to GetStatus(). Using this facility, a client can expect a callback (data or keep-alive) within the specified keep-alive time. Servers shall reset their keep-alive timers when real data is sent (i.e. it is not acceptable to constantly send the keep-alive callback at a fixed period equal to the keep-alive time irrespective of data callbacks).
The keep-alive callback consists of a call to OnEvent() with count set to zero. Keep-alive callbacks will not occur when the subscription is inactive. Keep-alive callbacks do not affect the value of LastUpdateTime returned by EventServer.GetStatus().

Syntax

Visual Basic (Declaration) 
Public Function SetKeepAlive( _
   ByVal _keepAliveTime As Integer, _
   ByRef revisedKeepAliveTime As Integer _
) As Integer
C# 
public int SetKeepAlive( 
   int _keepAliveTime,
   out int revisedKeepAliveTime
)

Parameters

_keepAliveTime
The maximum amount of time (in milliseconds) the client expects to receive a new subscription callback since the last subscription callback. A value of zero indicates the client does not wish to receive any keep-alive callbacks.
revisedKeepAliveTime
The KeepAliveTime the server is actually providing, which may differ from keepAliveTime.

Return Value

HResult success/error code

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

© 2004-2017 Advosol Inc. All Rights Reserved.