Class HeartbeatInstruction

Represents a HeartbeatInstruction.

Hierarchy

HeartbeatInstruction

Implements

IHeartbeatInstruction

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new HeartbeatInstruction(properties?: IHeartbeatInstruction): HeartbeatInstruction

- Defined in compiled.d.ts:4047
Constructs a new HeartbeatInstruction.

Parameters
- Optional properties: IHeartbeatInstruction
Returns HeartbeatInstruction

Properties

leaseCount

leaseCount: number | Long

HeartbeatInstruction leaseCount.

slotExpiration

slotExpiration: number | Long

HeartbeatInstruction slotExpiration.

Methods

toJSON

toJSON(): {}

- Defined in compiled.d.ts:4129
Converts this HeartbeatInstruction to JSON.

Returns {}

JSON object
- [k: string]: any

Static create

create(properties?: IHeartbeatInstruction): HeartbeatInstruction

- Defined in compiled.d.ts:4066
Creates a new HeartbeatInstruction instance using the specified properties.

Parameters
- Optional properties: IHeartbeatInstruction
Returns HeartbeatInstruction

HeartbeatInstruction instance

Static decode

decode(reader: Uint8Array | Reader, length?: number): HeartbeatInstruction

- Defined in compiled.d.ts:4092
Decodes a HeartbeatInstruction message from the specified reader or buffer.

throws

{Error} If the payload is not a reader or valid buffer

throws

{$protobuf.util.ProtocolError} If required fields are missing

Parameters
- reader: Uint8Array | Reader
  
  Reader or buffer to decode from
- Optional length: number
Returns HeartbeatInstruction

HeartbeatInstruction

Static decodeDelimited

decodeDelimited(reader: Uint8Array | Reader): HeartbeatInstruction

- Defined in compiled.d.ts:4101
Decodes a HeartbeatInstruction message from the specified reader or buffer, length delimited.

throws

{Error} If the payload is not a reader or valid buffer

throws

{$protobuf.util.ProtocolError} If required fields are missing

Parameters
- reader: Uint8Array | Reader
  
  Reader or buffer to decode from
Returns HeartbeatInstruction

HeartbeatInstruction

Static encode

encode(message: IHeartbeatInstruction, writer?: Writer): Writer

- Defined in compiled.d.ts:4074
Encodes the specified HeartbeatInstruction message. Does not implicitly verify messages.

Parameters
- message: IHeartbeatInstruction
  
  HeartbeatInstruction message or plain object to encode
- Optional writer: Writer
Returns Writer

Writer

Static encodeDelimited

encodeDelimited(message: IHeartbeatInstruction, writer?: Writer): Writer

- Defined in compiled.d.ts:4082
Encodes the specified HeartbeatInstruction message, length delimited. Does not implicitly verify messages.

Parameters
- message: IHeartbeatInstruction
  
  HeartbeatInstruction message or plain object to encode
- Optional writer: Writer
Returns Writer

Writer

Static fromObject

fromObject(object: {}): HeartbeatInstruction

- Defined in compiled.d.ts:4115
Creates a HeartbeatInstruction message from a plain object. Also converts values to their respective internal types.

Parameters
- object: {}
  
  Plain object
  - [k: string]: any
Returns HeartbeatInstruction

HeartbeatInstruction

Static toObject

toObject(message: HeartbeatInstruction, options?: IConversionOptions): {}

- Defined in compiled.d.ts:4123
Creates a plain object from a HeartbeatInstruction message. Also converts values to other types if specified.

Parameters
- message: HeartbeatInstruction
  
  HeartbeatInstruction
- Optional options: IConversionOptions
Returns {}

Plain object
- [k: string]: any

Static verify

verify(message: {}): null | string

- Defined in compiled.d.ts:4108
Verifies a HeartbeatInstruction message.

Parameters
- message: {}
  
  Plain object to verify
  - [k: string]: any
Returns null | string

null if valid, otherwise the reason why it is not

Generated using TypeDoc