Class ConnectionApprovalRequest

Request for connection approval (sent to approval callback).

Index

Constructors

Properties

_buildHash _connectionId _customData _projectId _remoteAddress

Accessors

buildHash connectionId customData projectId remoteAddress

Methods

assign clone isEqual isEqual

Constructors

constructor

new ConnectionApprovalRequest(
    connectionId?: number,
    remoteAddress?: Immutable<NetAddress>,
    projectId?: string,
    buildHash?: string,
    customData?: Iterable<number>,
): ConnectionApprovalRequest
Parameters
- OptionalconnectionId: number
- OptionalremoteAddress: Immutable<NetAddress>
- OptionalprojectId: string
- OptionalbuildHash: string
- OptionalcustomData: Iterable<number>
Returns ConnectionApprovalRequest

Properties

`Protected`_buildHash

_buildHash: string

`Protected`_connectionId

_connectionId: number

`Protected`_customData

_customData: number[]

`Protected`_projectId

_projectId: string

`Protected`_remoteAddress

_remoteAddress: NetAddress

Accessors

buildHash

get buildHash(): string

Build hash from Hello message.

Returns string
set buildHash(value: string): void
Parameters
- value: string
Returns void

connectionId

get connectionId(): number

Connection requesting approval.

Returns number
set connectionId(value: number): void
Parameters
- value: number
Returns void

customData

get customData(): Iterable<number>

Optional custom data from client.

Returns Iterable<number>
set customData(value: number[] | Iterable<number>): void
Parameters
- value: number[] | Iterable<number>
Returns void

projectId

get projectId(): string

Project ID from Hello message.

Returns string
set projectId(value: string): void
Parameters
- value: string
Returns void

remoteAddress

get remoteAddress(): NetAddress

Remote address of the connection.

Returns NetAddress
set remoteAddress(value: Immutable<NetAddress>): void
Parameters
- value: Immutable<NetAddress>
Returns void

Methods

assign

assign(other: Immutable<ConnectionApprovalRequest>): ConnectionApprovalRequest
Copies all properties defined by the prototype of ConnectionApprovalRequest from other to this instance.
Parameters
- other: Immutable<ConnectionApprovalRequest>
Returns ConnectionApprovalRequest

clone

clone(): ConnectionApprovalRequest

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

Returns ConnectionApprovalRequest

isEqual

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

`Static`isEqual

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