Class SetThrottle

Applies a throttle to the underlying conneciton

Inheritance

object

SetThrottle

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Akka.Remote.Transport

Assembly: Akka.Remote.dll

Syntax

public sealed class SetThrottle

Constructors

SetThrottle(Address, Direction, ThrottleMode)

Creates a new SetThrottle message.

Declaration

public SetThrottle(Address address, ThrottleTransportAdapter.Direction direction, ThrottleMode mode)

Parameters

Type	Name	Description
Address	address	The address of the throttle.
ThrottleTransportAdapter.Direction	direction	The direction of the throttle.
ThrottleMode	mode	The mode of the throttle.

Properties

Address

The address of the remote node we'll be throttling

Declaration

public Address Address { get; }

Property Value

Type	Description
Address

Direction

The direction of the throttle

Declaration

public ThrottleTransportAdapter.Direction Direction { get; }

Property Value

Type	Description
ThrottleTransportAdapter.Direction

Mode

The mode of the throttle

Declaration

public ThrottleMode Mode { get; }

Property Value

Type	Description
ThrottleMode

Methods

Equals(object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

object.Equals(object)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

Operators

operator ==(SetThrottle, SetThrottle)

Compares two specified SetThrottle for equality.

Declaration

public static bool operator ==(SetThrottle left, SetThrottle right)

Parameters

Type	Name	Description
SetThrottle	left	The first SetThrottle used for comparison
SetThrottle	right	The second SetThrottle used for comparison

Returns

Type	Description
bool	true if both SetThrottles are equal; otherwise false

operator !=(SetThrottle, SetThrottle)

Compares two specified SetThrottle for inequality.

Declaration

public static bool operator !=(SetThrottle left, SetThrottle right)

Parameters

Type	Name	Description
SetThrottle	left	The first SetThrottle used for comparison
SetThrottle	right	The second SetThrottle used for comparison

Returns

Type	Description
bool	true if both SetThrottles are not equal; otherwise false

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)