MI_SubscriptionDeliveryOptions_SetHeartbeatInterval function (mi.h)

Sets the heartbeat interval.

Syntax

MI_INLINE MI_Result MI_SubscriptionDeliveryOptions_SetHeartbeatInterval(
  MI_SubscriptionDeliveryOptions *self,
  MI_Interval                    *value
);

Parameters

self

A pointer to a MI_SubscriptionDeliveryOptions structure.

value

Interval between delivery of results whereby the server notifies the client that the server is still connected.

Return value

A value of the MI_Result enumeration that specifies the function return code. This can be one of the following codes.

Remarks

If no events are available, the server uses this interval to send a heartbeat back to the client so that the client knows that the server is still there. This function is relevant for push delivery.

Requirements

   
Minimum supported client Windows 8
Minimum supported server Windows Server 2012
Target Platform Windows
Header mi.h
Redistributable Windows Management Framework 3.0 on Windows Server 2008 R2 with SP1, Windows 7 with SP1, and Windows Server 2008 with SP2

See also

MI_Interval

MI_SubscriptionDeliveryOptions

MI_SubscriptionDeliveryOptions_GetDeliveryDestination

MI_SubscriptionDeliveryOptions_GetDeliveryPortNumber

MI_SubscriptionDeliveryOptions_GetDeliveryRetryAttempts

MI_SubscriptionDeliveryOptions_GetDeliveryRetryInterval

MI_SubscriptionDeliveryOptions_GetHeartbeatInterval

MI_SubscriptionDeliveryOptions_SetDeliveryDestination

MI_SubscriptionDeliveryOptions_SetDeliveryPortNumber

MI_SubscriptionDeliveryOptions_SetDeliveryRetryAttempts

MI_SubscriptionDeliveryOptions_SetDeliveryRetryInterval