C-DEngine 5.105

TheThing..::..SetPublishThrottle Method

sets a throttle time in milliseconds for all properties of TheThing. Changes to properties will only be sent at a maximum sample rate given in pThrottleInMs TheThing will consolidate all changes in one SETP call. If a property changes multiple times only the last value will be used.2

Namespace:  nsCDEngine.Engines.ThingService
Assembly:  C-DEngine (in C-DEngine.dll)

Syntax


public int SetPublishThrottle(
	int pThrottleInMs,
	eThrottleKind pKind
)
Public Function SetPublishThrottle ( _
	pThrottleInMs As Integer, _
	pKind As eThrottleKind _
) As Integer
public:
int^ SetPublishThrottle(
	int^ pThrottleInMs, 
	eThrottleKind^ pKind
)

Parameters

pThrottleInMs
Type: Int32
Snapshot Throttle time in MS
pKind
Type: nsCDEngine.Engines.ThingService..::..eThrottleKind
Algorithm to be used for the throttle (in V3.1 only LAST is supported)

Return Value