Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MTProtoSender

Hierarchy

  • MTProtoSender

Index

Properties

Constructors

Accessors

Methods

Properties

Static DEFAULT_OPTIONS

DEFAULT_OPTIONS: { logger: null; retries: number; delay: number; autoReconnect: boolean; connectTimeout: null; authKeyCallback: null; updateCallback: null; autoReconnectCallback: null; isMainSender: null; senderCallback: null; onConnectionBreak: undefined; securityChecks: boolean } = ...

Type declaration

  • logger: null
  • retries: number
  • delay: number
  • autoReconnect: boolean
  • connectTimeout: null
  • authKeyCallback: null
  • updateCallback: null
  • autoReconnectCallback: null
  • isMainSender: null
  • senderCallback: null
  • onConnectionBreak: undefined
  • securityChecks: boolean

Optional _connection

_connection?: Connection

_updateCallback

_updateCallback: ((client: TelegramClient, update: UpdateConnectionState) => void)

Type declaration

_userConnected

_userConnected: boolean

isReconnecting

isReconnecting: boolean

_reconnecting

_reconnecting: boolean

_disconnected

_disconnected: boolean

Readonly authKey

authKey: AuthKey

userDisconnected

userDisconnected: boolean

isConnecting

isConnecting: boolean

_authenticated

_authenticated: boolean

Optional cancellableRecvLoopPromise

cancellableRecvLoopPromise?: CancellablePromise<any>

Constructors

constructor

Accessors

dcId

  • get dcId(): number
  • set dcId(dcId: number): void

Methods

connect

  • connect(connection: Connection, force: boolean): Promise<boolean>

isConnected

  • isConnected(): boolean

_transportConnected

  • _transportConnected(): undefined | boolean

disconnect

  • disconnect(): Promise<void>

  • Cleanly disconnects the instance from the network, cancels all pending requests, and closes the send and receive loops.

    Returns Promise<void>

send

  • send(request: AnyRequest): undefined | Promise<unknown>

  • This method enqueues the given request to be sent. Its send state will be saved until a response arrives, and a Future that will be resolved when the response arrives will be returned:

    .. code-block:: javascript

    async def method():

    Sending (enqueued for the send loop)

    future = sender.send(request)

    Receiving (waits for the receive loop to read the result)

    result = await future

    Designed like this because Telegram may send the response at any point, and it can send other items while one waits for it. Once the response for this future arrives, it is set with the received result, quite similar to how a receive() call would otherwise work.

    Since the receiving part is "built in" the future, it's impossible to await receive a result that was never sent.

    Parameters

    Returns undefined | Promise<unknown>

addStateToQueue

_disconnect

  • _disconnect(): Promise<void>

_cancelLoops

  • _cancelLoops(): void

_recvLoop

  • _recvLoop(): Promise<void>

_handleBadAuthKey

  • _handleBadAuthKey(shouldSkipForMain?: boolean): void

_handleUpdate

  • _handleUpdate(message: TLMessage): Promise<void>

_handleAck

  • _handleAck(): void

reconnect

  • reconnect(): void

_reconnect

  • _reconnect(): Promise<void>

Generated using TypeDoc