Class PeerStatus

The status of a connected peer in the P2P network

Implements

Encodable

Index

Constructors

Properties

connectionType? networkAddress networkType? encodingSchemaValue

Accessors

Methods

getEncodingSchema toEncodingData fromEncodingData

Constructors

constructor

new PeerStatus(__namedParameters): PeerStatus
Creates a new PeerStatus object.
Parameters
- __namedParameters: {
      connectionType?: string;
      networkAddress: string;
      networkType?: string;
  }
  - Optional connectionType?: string
  - networkAddress: string
  - Optional networkType?: string
Returns PeerStatus
- Defined in client/v2/algod/models/types.ts:5259

Properties

`Optional` connectionType

connectionType?: string

Connection type

networkAddress

networkAddress: string

Network address of the peer

`Optional` networkType

networkType?: string

Network type

`Static` `Private` encodingSchemaValue

encodingSchemaValue: undefined | Schema

Accessors

`Static` encodingSchema

get encodingSchema(): Schema
Returns Schema
- Defined in client/v2/algod/models/types.ts:5214

Methods

getEncodingSchema

getEncodingSchema(): Schema
Get the encoding Schema for this object, used to prepare the encoding data for msgpack and JSON.

Returns Schema
Implementation of Encodable.getEncodingSchema
- Defined in client/v2/algod/models/types.ts:5274

toEncodingData

toEncodingData(): Map<string, unknown>
Extract the encoding data for this object. This data, after being prepared by the encoding Schema, can be encoded to msgpack or JSON.

Returns Map<string, unknown>
Implementation of Encodable.toEncodingData
- Defined in client/v2/algod/models/types.ts:5278

`Static` fromEncodingData

fromEncodingData(data): PeerStatus
Parameters
- data: unknown
Returns PeerStatus
- Defined in client/v2/algod/models/types.ts:5286

Generated using TypeDoc