Class SetThrottle

Applies a throttle to the underlying conneciton

Inheritance
Object
SetThrottle
Inherited Members
Namespace: Akka.Remote.Transport
Assembly: Akka.Remote.dll
Syntax
public sealed class SetThrottle

Constructors

| Improve this Doc View Source

SetThrottle(Address, ThrottleTransportAdapter.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

| Improve this Doc View Source

Address

The address of the remote node we'll be throttling

Declaration
public Address Address { get; }
Property Value
Type Description
Address
| Improve this Doc View Source

Direction

The direction of the throttle

Declaration
public ThrottleTransportAdapter.Direction Direction { get; }
Property Value
Type Description
ThrottleTransportAdapter.Direction
| Improve this Doc View Source

Mode

The mode of the throttle

Declaration
public ThrottleMode Mode { get; }
Property Value
Type Description
ThrottleMode

Methods

| Improve this Doc View Source

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
Boolean
Overrides
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides

Operators

| Improve this Doc View Source

Equality(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
Boolean

true if both SetThrottles are equal; otherwise false
| Improve this Doc View Source

Inequality(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
Boolean

true if both SetThrottles are not equal; otherwise false

Extension Methods