Class TimeoutParameters

Namespace

Concordium.Grpc.V2

Assembly

Concordium.Sdk.dll

Parameters that determine timeouts in the consensus protocol used from protocol version 6.

public sealed class TimeoutParameters : IMessage<TimeoutParameters>, IEquatable<TimeoutParameters>, IDeepCloneable<TimeoutParameters>, IBufferMessage, IMessage

Inheritance

object

TimeoutParameters

Implements

IMessage<TimeoutParameters>

IEquatable<TimeoutParameters>

IDeepCloneable<TimeoutParameters>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

TimeoutParameters()

public TimeoutParameters()

TimeoutParameters(TimeoutParameters)

public TimeoutParameters(TimeoutParameters other)

Parameters

other TimeoutParameters

Fields

TimeoutBaseFieldNumber

Field number for the "timeout_base" field.

public const int TimeoutBaseFieldNumber = 1

Field Value

int

TimeoutDecreaseFieldNumber

Field number for the "timeout_decrease" field.

public const int TimeoutDecreaseFieldNumber = 3

Field Value

int

TimeoutIncreaseFieldNumber

Field number for the "timeout_increase" field.

public const int TimeoutIncreaseFieldNumber = 2

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Parser

public static MessageParser<TimeoutParameters> Parser { get; }

Property Value

MessageParser<TimeoutParameters>

TimeoutBase

The base value for triggering a timeout

public Duration TimeoutBase { get; set; }

Property Value

Duration

TimeoutDecrease

Factor for decreasing the timeout. Must be between 0 and 1.

public Ratio TimeoutDecrease { get; set; }

Property Value

Ratio

TimeoutIncrease

Factor for increasing the timeout. Must be greater than 1.

public Ratio TimeoutIncrease { get; set; }

Property Value

Ratio

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

Clone()

Creates a deep clone of this object.

public TimeoutParameters Clone()

Returns

TimeoutParameters

A deep clone of this object.

Equals(TimeoutParameters)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(TimeoutParameters other)

Parameters

other TimeoutParameters

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object other)

Parameters

other object

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

MergeFrom(TimeoutParameters)

Merges the given message into this one.

public void MergeFrom(TimeoutParameters other)

Parameters

other TimeoutParameters

Remarks

See the user guide for precise merge semantics.

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.