@web-core/web-sdk
    Preparing search index...

    Interface IPubsubConnectorService

    interface IPubsubConnectorService {
        addSubscriptions(
            subId: number,
            symbols: string[],
            fields: string[],
            callback?: (data: any) => any,
        ): void;
        callback(data: PubsubData): void;
        changeUser(
            username?: string,
            password?: string,
            token?: string,
            resource?: string,
        ): Promise<void>;
        checkSubscriptionHasSnapshot(symbols: string[], fields: string[]): void;
        connect(): Promise<WebSocket>;
        disconnect(): Promise<void>;
        feedSubscriptions(data: PubsubData): void;
        getFieldSnapShotValue(definitionId: string, fieldShortCode: string): any;
        getLicenses(): PubsubLicense[];
        getSocket(): WebSocket;
        getSubscriptions(): any;
        getSubscriptionsById(id: string): any;
        isSocketReady(): boolean;
        login(username: string, password: string, resource: string): void;
        messageEvent(data: PubsubData): void;
        resetReconnectCount(): void;
        reSubscribe(): void;
        scheduleHeartbeat(): void;
        send(message: string): void;
        setGlobalCallback(callback: Function): void;
        setOptions(options: any): void;
        subscribe(
            symbols: string[],
            fields: string[],
            callback?: (data: PubsubData) => void,
        ): number;
        unSubscribe(id: number): void;
        unSubscribeAll(): void;
    }
    Index

    Methods

    addSubscriptions callback changeUser checkSubscriptionHasSnapshot connect disconnect feedSubscriptions getFieldSnapShotValue getLicenses getSocket getSubscriptions getSubscriptionsById isSocketReady login messageEvent resetReconnectCount reSubscribe scheduleHeartbeat send setGlobalCallback setOptions subscribe unSubscribe unSubscribeAll

    Methods

    • Parameters

      • subId: number

        : subscription id

      • symbols: string[]

        : symbols list

      • fields: string[]

        : fields list

      • Optionalcallback: (data: any) => any

        : callback method

      Returns void

      check subscription has snapshot data if has sent it to pubsub sendData service

    • Parameters

      Returns void

      callback

    • Parameters

      • Optionalusername: string
      • Optionalpassword: string
      • Optionaltoken: string
      • Optionalresource: string

      Returns Promise<void>

      disconnect from socket

    • Parameters

      • symbols: string[]

        symbols list

      • fields: string[]

        fields list

      Returns void

      check subscription has snapshot data if has sent it to pubsub sendData service

    • Returns Promise<WebSocket>

      connect to socket

    • Returns Promise<void>

      disconnect from socket

    • Parameters

      Returns void

      feed subscriptions

    • Parameters

      • definitionId: string

        definition id

      • fieldShortCode: string

        fields shortcode

      Returns any

      field value

      get field snapshot value if exsist

    • Returns PubsubLicense[]

      user licenses

      get user licenses

    • Returns WebSocket

      get socket connection

    • Returns any

      get subscriptions

    • Parameters

      • id: string

        id

      Returns any

      get subscription by id

    • Returns boolean

      is socket ready

    • Parameters

      • username: string

        username

      • password: string

        password

      • resource: string

        resource

      Returns void

      send login message to socket

    • Parameters

      Returns void

      send message via socket

    • Returns void

      reset reconnect count

    • Returns void

      re subscribe with old subscription map

    • Returns void

      schedule heart beat for socket service.

    • Parameters

      • message: string

        message

      Returns void

      send message via socket

    • Parameters

      • callback: Function

      Returns void

      set global send data callback

    • Parameters

      • options: any

        : options

      Returns void

      set options for socket

    • Parameters

      • symbols: string[]

        symbols list

      • fields: string[]

        fields list

      • Optionalcallback: (data: PubsubData) => void

        callback method

      Returns number

      subscription id

      subscribe

    • Parameters

      • id: number

        subscription id

      Returns void

      unsubscribe with subscription id

    • Returns void

      unsubscribe all subscriptions

    Settings

    Member Visibility

    On This Page

    Methods