Method ClearSubscriptions

Namespace

Skyline.DataMiner.Core.DataMinerSystem.Common

Assembly

Skyline.DataMiner.Core.DataMinerSystem.Common.dll

ClearSubscriptions(string, string, SubscriptionFilter[], bool)

Clear an SLNet Subscription.

void ClearSubscriptions(string setId, string internalHandleIdentifier, SubscriptionFilter[] subscriptions, bool force = false)

Parameters

setId string

The Set ID this subscription belongs to.

internalHandleIdentifier string

A unique identifier for a specific subscriptionFilter.

subscriptions SubscriptionFilter[]

List of SubscriptionFilter instances to remove.

force bool

When this subscription would be the last from a setID. When true it will clear any waiting event. If false, then it will wait and finish processing all queued events before clearing the subscription.

Exceptions

ArgumentNullException

setId, internalHandleIdentifier is null.

InvalidOperationException

Could not remove SLNet subscriptions within 10 minutes.

ClearSubscriptions(string, string, SubscriptionFilter[], TimeSpan, bool)

Clears an SLNet Subscription.

void ClearSubscriptions(string setId, string internalHandleIdentifier, SubscriptionFilter[] subscriptions, TimeSpan subscribeTimeout, bool force = false)

Parameters

setId string

The Set ID this subscription belongs to.

internalHandleIdentifier string

A unique identifier for a specific subscriptionFilter.

subscriptions SubscriptionFilter[]

List of SubscriptionFilter instances to remove.

subscribeTimeout TimeSpan

Subscribe timeout.

force bool

When this subscription would be the last from a setID. When true it will clear any waiting event. If false, then it will wait and finish processing all queued events before clearing the subscription.

Exceptions

ArgumentNullException

setId, internalHandleIdentifier is null.

InvalidOperationException

Could not remove SLNet subscriptions within the specified timeout. This is usually when SLNet is overloaded.