Class NetPeerInfo

Information about a connected peer.

Index

Constructors

Properties

_address _connectedAtMs _connectionId _lastHeartbeatSentMs _lastMessageTimeMs _role _roundTripTime

Accessors

address connectedAtMs connectionId lastHeartbeatSentMs lastMessageTimeMs role roundTripTime

Methods

clone isEqual isEqual

Constructors

constructor

new NetPeerInfo(
    connectionId?: number,
    address?: Immutable<NetAddress>,
    role?: EnumValue<NetRole>,
    connectedAtMs?: number,
    lastMessageTimeMs?: number,
    roundTripTime?: RoundTripTimeState,
    lastHeartbeatSentMs?: number,
): NetPeerInfo
Parameters
- OptionalconnectionId: number
- Optionaladdress: Immutable<NetAddress>
- Optionalrole: EnumValue<NetRole>
- OptionalconnectedAtMs: number
- OptionallastMessageTimeMs: number
- OptionalroundTripTime: RoundTripTimeState
- OptionallastHeartbeatSentMs: number
Returns NetPeerInfo

Properties

`Protected`_address

_address: NetAddress

`Protected`_connectedAtMs

_connectedAtMs: number

`Protected`_connectionId

_connectionId: number

`Protected`_lastHeartbeatSentMs

_lastHeartbeatSentMs: number

`Protected`_lastMessageTimeMs

_lastMessageTimeMs: number

`Protected`_role

_role: EnumValue<NetRole>

`Protected`_roundTripTime

_roundTripTime: RoundTripTimeState

Accessors

address

get address(): NetAddress

Remote address of the peer.

Returns NetAddress

connectedAtMs

get connectedAtMs(): number

Time when the peer connected (epoch ms).

Returns number

connectionId

get connectionId(): number

Unique connection ID.

Returns number

lastHeartbeatSentMs

get lastHeartbeatSentMs(): number

Time when last heartbeat was sent to this peer (epoch ms).

Returns number

lastMessageTimeMs

get lastMessageTimeMs(): number

Last received message time (epoch ms).

Returns number

role

get role(): EnumValue<NetRole>

Role of the peer (Client, Host, Dedicated).

Returns EnumValue<NetRole>

roundTripTime

get roundTripTime(): RoundTripTimeState

Round-trip time calculation state.

Returns RoundTripTimeState

Methods

clone

clone(): NetPeerInfo

Clones this instance and returns a new NetPeerInfo with identical values.

Returns NetPeerInfo

isEqual

isEqual(this: Immutable<NetPeerInfo>, other: Immutable<NetPeerInfo>): boolean
Determines if this NetPeerInfo instance is equal to the other instance.
Parameters
- this: Immutable<NetPeerInfo>
- other: Immutable<NetPeerInfo>
Returns boolean

`Static`isEqual

isEqual(lhs: Immutable<NetPeerInfo>, rhs: Immutable<NetPeerInfo>): boolean
Determines if both NetPeerInfo instances are equal.
Parameters
- lhs: Immutable<NetPeerInfo>
- rhs: Immutable<NetPeerInfo>
Returns boolean