Class SessionConnection

A connection to a single DC.

Hierarchy

PersistentConnection
- SessionConnection

Constructors

constructor

new SessionConnection(
params: SessionConnectionParams,
log: Logger,
): SessionConnection
Parameters
- params: SessionConnectionParams
- log: Logger
Returns SessionConnection
Overrides PersistentConnection.constructor
- Defined in packages/core/src/network/session-connection.ts:108

Properties

_destroyed

_destroyed: boolean = false

`Protected`_disconnectedManually

_disconnectedManually: boolean = false

`Protected` `Optional` `Readonly`_floodControl

_floodControl?: ConnectionFloodController

_inactive

_inactive: boolean = true

`Protected` `Optional`_mtproxyInfo

_mtproxyInfo?: RawInputClientProxy

`Readonly`_session

_session: MtprotoSession

_usable

_usable: boolean = false

`Readonly`log

log: Logger

`Readonly`onAuthBegin

onAuthBegin: Emitter<void> = ...

`Readonly`onDisconnect

onDisconnect: Emitter<void> = ...

`Readonly`onError

onError: Emitter<Error> = ...

`Readonly`onFutureSalts

onFutureSalts: Emitter<RawMt_future_salt[]> = ...

`Readonly`onKeyChange

onKeyChange: Emitter<Uint8Array<ArrayBufferLike> | null> = ...

`Readonly`onRequestAuth

onRequestAuth: Emitter<void> = ...

`Readonly`onTmpKeyChange

onTmpKeyChange: Emitter<[Uint8Array<ArrayBufferLike>, number] | null> = ...

`Readonly`onUpdate

onUpdate: Emitter<TypeUpdates> = ...

`Readonly`onUsable

onUsable: Emitter<void> = ...

`Readonly`onWait

onWait: Emitter<number> = ...

`Readonly`params

params: SessionConnectionParams

Accessors

isConnected

get isConnected(): boolean
Returns boolean
Inherited from PersistentConnection.isConnected
- Defined in packages/core/src/network/persistent-connection.ts:283

Methods

_authorize

_authorize(): void
Returns void
- Defined in packages/core/src/network/session-connection.ts:343

`Protected`_dropQueuedPlainMessages

_dropQueuedPlainMessages(): void
Remove queued (not yet sent) unencrypted messages. Should be called when an authorization attempt fails, since otherwise its messages would be sent once connected, confusing the next attempt

Returns void
Inherited from PersistentConnection._dropQueuedPlainMessages
- Defined in packages/core/src/network/persistent-connection.ts:279

`Protected`_onInactivityTimeout

_onInactivityTimeout(): void
Returns void
Overrides PersistentConnection._onInactivityTimeout
- Defined in packages/core/src/network/session-connection.ts:1671

`Protected`_rescheduleInactivity

_rescheduleInactivity(): void
Returns void
Inherited from PersistentConnection._rescheduleInactivity
- Defined in packages/core/src/network/persistent-connection.ts:406

_resetSession

_resetSession(reason?: string): void
Parameters
- reason: string = 'session reset'
Returns void
- Defined in packages/core/src/network/session-connection.ts:1471

changeTransport

changeTransport(transport: TelegramTransport): Promise<void>
Parameters
- transport: TelegramTransport
Returns Promise<void>
Inherited from PersistentConnection.changeTransport
- Defined in packages/core/src/network/persistent-connection.ts:348

connect

connect(): void
Returns void
Inherited from PersistentConnection.connect
- Defined in packages/core/src/network/persistent-connection.ts:362

destroy

destroy(): Promise<void>
Returns Promise<void>
Overrides PersistentConnection.destroy
- Defined in packages/core/src/network/session-connection.ts:180

destroyAuthKey

destroyAuthKey(): void
Returns void
- Defined in packages/core/src/network/session-connection.ts:185

disconnectManual

disconnectManual(): Promise<void>
Returns Promise<void>
Inherited from PersistentConnection.disconnectManual
- Defined in packages/core/src/network/persistent-connection.ts:387

getAuthKey

getAuthKey(temp?: boolean): Uint8Array<ArrayBufferLike> | null
Parameters
- temp: boolean = false
Returns Uint8Array<ArrayBufferLike> | null
- Defined in packages/core/src/network/session-connection.ts:134

`Protected`handleError

handleError(error: Error): void
Parameters
- error: Error
Returns void
Overrides PersistentConnection.handleError
- Defined in packages/core/src/network/session-connection.ts:259

notifyNetworkChanged

notifyNetworkChanged(online: boolean): void
Parameters
- online: boolean
Returns void
- Defined in packages/core/src/network/session-connection.ts:1620

onClosed

onClosed(): void
Returns void
Overrides PersistentConnection.onClosed
- Defined in packages/core/src/network/session-connection.ts:158

onConnected

onConnected(): void
Returns void
Overrides PersistentConnection.onConnected
- Defined in packages/core/src/network/session-connection.ts:229

`Protected`onConnectionUsable

onConnectionUsable(): void
Returns void
- Defined in packages/core/src/network/session-connection.ts:326

`Protected`onMessage

onMessage(data: Uint8Array): void
Parameters
- data: Uint8Array
Returns void
Overrides PersistentConnection.onMessage
- Defined in packages/core/src/network/session-connection.ts:589

reconnect

reconnect(): void
Returns void
Inherited from PersistentConnection.reconnect
- Defined in packages/core/src/network/persistent-connection.ts:373

reset

reset(forever?: boolean): void
Parameters
- forever: boolean = false
Returns void
- Defined in packages/core/src/network/session-connection.ts:194

send

send(data: Uint8Array): Promise<void>
Parameters
- data: Uint8Array
Returns Promise<void>
Inherited from PersistentConnection.send
- Defined in packages/core/src/network/persistent-connection.ts:434

sendRpc

sendRpc<T extends RpcMethod>(
    request: T,
    timeout?: number,
    abortSignal?: AbortSignal,
    chainId?: string | number,
): Promise<RpcCallReturn[T["_"]]>
Type Parameters
- T extends RpcMethod
Parameters
- request: T
- Optionaltimeout: number
- OptionalabortSignal: AbortSignal
- OptionalchainId: string | number
Returns Promise<RpcCallReturn[T["_"]]>
- Defined in packages/core/src/network/session-connection.ts:1494

setInactivityTimeout

setInactivityTimeout(timeout?: number): void
Parameters
- Optionaltimeout: number
Returns void
Inherited from PersistentConnection.setInactivityTimeout
- Defined in packages/core/src/network/persistent-connection.ts:422

setUsePfs

setUsePfs(usePfs: boolean): void
Parameters
- usePfs: boolean
Returns void
- Defined in packages/core/src/network/session-connection.ts:142

waitForUnencryptedMessage

waitForUnencryptedMessage(
timeout?: number,
): Promise<Uint8Array<ArrayBufferLike>>
Parameters
- timeout: number = 5000
Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in packages/core/src/network/session-connection.ts:573

Class SessionConnection

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SessionConnection

Properties

_destroyed

Protected_disconnectedManually

Protected Optional Readonly_floodControl

_inactive

Protected Optional_mtproxyInfo

Readonly_session

_usable

Readonlylog

ReadonlyonAuthBegin

ReadonlyonDisconnect

ReadonlyonError

ReadonlyonFutureSalts

ReadonlyonKeyChange

ReadonlyonRequestAuth

ReadonlyonTmpKeyChange

ReadonlyonUpdate

ReadonlyonUsable

ReadonlyonWait

Readonlyparams

Accessors

isConnected

Returns boolean

Methods

_authorize

Returns void

Protected_dropQueuedPlainMessages

Returns void

Protected_onInactivityTimeout

Returns void

Protected_rescheduleInactivity

Returns void

_resetSession

Parameters

Returns void

changeTransport

Parameters

Returns Promise<void>

connect

Returns void

destroy

Returns Promise<void>

destroyAuthKey

Returns void

disconnectManual

Returns Promise<void>

getAuthKey

Parameters

Returns Uint8Array<ArrayBufferLike> | null

ProtectedhandleError

Parameters

Returns void

notifyNetworkChanged

Parameters

Returns void

onClosed

Returns void

onConnected

Returns void

ProtectedonConnectionUsable

Returns void

ProtectedonMessage

Parameters

Returns void

reconnect

Returns void

reset

Parameters

Returns void

`Protected`_disconnectedManually

`Protected` `Optional` `Readonly`_floodControl

`Protected` `Optional`_mtproxyInfo

`Readonly`_session

`Readonly`log

`Readonly`onAuthBegin

`Readonly`onDisconnect

`Readonly`onError

`Readonly`onFutureSalts

`Readonly`onKeyChange

`Readonly`onRequestAuth

`Readonly`onTmpKeyChange

`Readonly`onUpdate

`Readonly`onUsable

`Readonly`onWait

`Readonly`params

`Protected`_dropQueuedPlainMessages

`Protected`_onInactivityTimeout

`Protected`_rescheduleInactivity

`Protected`handleError

`Protected`onConnectionUsable

`Protected`onMessage