Interface ServerClientConnection

interface ServerClientConnection {
    authorization: string;
    clusters: number[];
    connection: Socket | TLSSocket;
    id: string;
    server: Server;
    shards: number[];
    type: string;
    close(reason?, allowReconnect?): Promise<boolean>;
    destroy(reason?): boolean;
    pause(): void;
    ping(data?, timeout?): Promise<number>;
    request(data, timeout?): Promise<any>;
    resume(): void;
    send(data): Promise<void>;
}

Hierarchy

  • Connection
    • ServerClientConnection

Properties

authorization clusters connection id server shards type

Methods

close destroy pause ping request resume send

Properties

authorization

authorization: string

clusters

clusters: number[]

connection

connection: Socket | TLSSocket

id

id: string

server

server: Server

shards

shards: number[]

type

type: string

Methods

close

  • close(reason?, allowReconnect?): Promise<boolean>

  • Parameters

    • Optional reason: any
    • Optional allowReconnect: boolean

    Returns Promise<boolean>

destroy

  • destroy(reason?): boolean

  • Parameters

    • Optional reason: any

    Returns boolean

pause

  • pause(): void

  • Returns void

ping

  • ping(data?, timeout?): Promise<number>

  • Parameters

    • Optional data: any
    • Optional timeout: number

    Returns Promise<number>

request

  • request(data, timeout?): Promise<any>

  • Parameters

    • data: any
    • Optional timeout: number

    Returns Promise<any>

resume

  • resume(): void

  • Returns void

send

  • send(data): Promise<void>

  • Parameters

    • data: any

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

authorizationclustersconnectionidservershardstypeclosedestroypausepingrequestresumesend

Generated using TypeDoc