Class SessionJoinResponse

Response from session join attempt.

Index

Constructors

Properties

_connectionId _hostAddress _rejectReason _serverTimeEpochMs _success

Accessors

connectionId hostAddress rejectReason serverTimeEpochMs success

Methods

assign clone isEqual isEqual

Constructors

constructor

new SessionJoinResponse(
    success?: boolean,
    connectionId?: number,
    rejectReason?: string,
    hostAddress?: Immutable<NetAddress>,
    serverTimeEpochMs?: number,
): SessionJoinResponse
Parameters
- Optionalsuccess: boolean
- OptionalconnectionId: number
- OptionalrejectReason: string
- OptionalhostAddress: Immutable<NetAddress>
- OptionalserverTimeEpochMs: number
Returns SessionJoinResponse

Properties

`Protected`_connectionId

_connectionId: number

`Protected`_hostAddress

_hostAddress: NetAddress

`Protected`_rejectReason

_rejectReason: string

`Protected`_serverTimeEpochMs

_serverTimeEpochMs: number

`Protected`_success

_success: boolean

Accessors

connectionId

get connectionId(): number

Assigned connection ID.

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

hostAddress

get hostAddress(): NetAddress

Host address to connect to (for clients).

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

rejectReason

get rejectReason(): string

Rejection reason (if Success is false).

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

serverTimeEpochMs

get serverTimeEpochMs(): number

Server time at join (epoch ms).

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

success

get success(): boolean

True if join succeeded.

Returns boolean
set success(value: boolean): void
Parameters
- value: boolean
Returns void

Methods

assign

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

clone

clone(): SessionJoinResponse

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

Returns SessionJoinResponse

isEqual

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

`Static`isEqual

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