Skip to content
Orleans logoMicrosoft Orleans

IActivationRebalancer Methods

A gateway to interface with the activation rebalancer.

GetRebalancingReport(bool)

abstract
public abstract ValueTask<RebalancingReport> GetRebalancingReport(bool force = false)
Returns the rebalancing report.

The report can lag behind if you choose a session cycle period less than Orleans.Placement.Rebalancing.IActivationRebalancerMonitor.WorkerReportPeriod.

Parameters

forcebool
If set to true returns the most current report.

ResumeRebalancing

abstract
public abstract Task ResumeRebalancing()
Resumes rebalancing if its suspended, otherwise its a no-op.

SubscribeToReports(IActivationRebalancerReportListener)

abstract
public abstract void SubscribeToReports(IActivationRebalancerReportListener listener)
Subscribe to activation rebalancer reports.

Parameters

listenerIActivationRebalancerReportListener
The component that will be notified.

SuspendRebalancing(TimeSpan?)

abstract
public abstract Task SuspendRebalancing(TimeSpan? duration = null)
Suspends rebalancing if its running, otherwise its a no-op.

Parameters

durationTimeSpan?
The amount of time to suspend the rebalancer.

null means suspend indefinitely.