Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IWebCommunicator

Hierarchy

  • IWebCommunicator

Implemented by

Index

Methods

Methods

close

  • close(code?: undefined | number, reason?: undefined | string): Promise<void>
  • Close connection.

    Close connection with the remote websocket system.

    It destories all RFCs (remote function calls) between this and remote websocket system (through Driver<Controller>) that are not returned (completed) yet. The destruction causes all incompleted RFCs to throw exceptions.

    If parametric code and reason are specified, it means the disconnection is abnormal and it would throw special exceptions (WebError) to the incompleted RFCs.

    Parameters

    • Optional code: undefined | number

      Closing code.

    • Optional reason: undefined | string

      Reason why.

    Returns Promise<void>

Generated using TypeDoc