Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CGadgetEndpoint

Hierarchy

  • CAardvarkEndpoint
    • CGadgetEndpoint

Index

Constructors

Methods

Constructors

constructor

  • new CGadgetEndpoint(gadgetUri: string, openHandler: OpenHandler, defaultHandler?: AsyncMessageHandler): CGadgetEndpoint

  • Parameters

    • gadgetUri: string
    • openHandler: OpenHandler
    • Default value defaultHandler: AsyncMessageHandler = null

    Returns CGadgetEndpoint

Methods

allowReconnect

  • allowReconnect(): void

getEndpointId

  • getEndpointId(): number

getGadgetManifest

  • getGadgetManifest(gadgetUri: string): Promise<AardvarkManifest>

  • Parameters

    • gadgetUri: string

    Returns Promise<AardvarkManifest>

onClose

  • onClose(ev: CloseEvent): void

onMessage

  • onMessage(msgEvent: MessageEvent): Promise<void>

  • Parameters

    • msgEvent: MessageEvent

    Returns Promise<void>

onOpen

  • onOpen(): void

onSetEndpointTypeResponse

  • onSetEndpointTypeResponse(m: MsgSetEndpointTypeResponse): Promise<void>

  • Parameters

    • m: MsgSetEndpointTypeResponse

    Returns Promise<void>

registerAsyncHandler

  • registerAsyncHandler(type: MessageType, handler: AsyncMessageHandler): void

  • Parameters

    • type: MessageType
    • handler: AsyncMessageHandler

    Returns void

registerHandler

  • registerHandler(type: MessageType, handler: MessageHandler): void

  • Parameters

    • type: MessageType
    • handler: MessageHandler

    Returns void

sendMessage

  • sendMessage(type: MessageType, msg: any, sendingNode?: number): number

  • Parameters

    • type: MessageType
    • msg: any
    • Optional sendingNode: number

    Returns number

sendMessageAndWaitForResponse

  • sendMessageAndWaitForResponse<T>(type: MessageType, msg: any, responseType: MessageType): Promise<[T, Envelope]>

  • Type parameters

    • T

    Parameters

    • type: MessageType
    • msg: any
    • responseType: MessageType

    Returns Promise<[T, Envelope]>

sendReply

  • sendReply(type: MessageType, msg: any, replyTo: Envelope, sender?: EndpointAddr): void

  • Parameters

    • type: MessageType
    • msg: any
    • replyTo: Envelope
    • Default value sender: EndpointAddr = undefined

    Returns void

Generated using TypeDoc