@zeroc/ice
    Preparing search index...

    Class AdaptiveLoadBalancingPolicy

    The load balancing policy that returns the endpoints of the server(s) with the lowest load average.

    The Slice compiler generated this class from Slice class ::IceGrid::AdaptiveLoadBalancingPolicy.

    Hierarchy (View Summary)

    Index

    Constructors

    • One-shot constructor to initialize all data members.

      Parameters

      • OptionalnReplicas: string

        The number of replicas that will be used to gather the endpoints of a replica group.

      • OptionalloadSample: string

        The load sample to use for the load balancing.

      Returns AdaptiveLoadBalancingPolicy

    Properties

    loadSample: string

    The load sample to use for the load balancing. The allowed values for this attribute are "1", "5" and "15", representing respectively the load average over the past minute, the past 5 minutes and the past 15 minutes.

    nReplicas: string

    The number of replicas that will be used to gather the endpoints of a replica group.

    Methods

    • Obtains the sliced data associated with this instance.

      Returns SlicedData | null

      The sliced data if this value was sliced during unmarshaling, null otherwise. Unknown slices are preserved only when the sender uses the sliced format.

    • Obtains the Slice type ID of the most-derived class supported by this object.

      Returns string

      The type ID.

    • The Ice runtime invokes this method after unmarshaling an object's data members. This allows a subclass to override this method in order to perform additional initialization.

      Returns void

    • The Ice runtime invokes this method prior to marshaling an object's data members. This allows a subclass to override this method in order to validate its data members.

      Returns void

    • Obtains the Slice type ID of this type.

      Returns string

      The return value is always "::Ice::Object".