Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SharedWorkerConnector<Provider>

SharedWorker Connector

  • available only in Web Browser.

The SharedWorkerConnector is a communicator class, who can connect to an SharedWorker instance and communicate with it using RFC (Remote Function Call), considering the SharedWorker as a remote system (WorkerServer).

You can connect to an SharedWorker instance with connect() method. If the SharedWorker instance does not exist yet, a new SharedWorker instance would be newly created. After the creation, you have to let the SharedWorker program to open a sever using the SharedWorkerServer.open() method. Your connection would be linked with a SharedWorkerAcceptor object in the server.

After your business has been completed, you've to close the SharedWorker using one of them below. If you don't close that, vulnerable memory usage and communication channel would not be destroyed and it may cause the memory leak:

author

Jeongho Nam http://samchon.org

Type parameters

  • Provider: object

    Type of features provided for remote system.

Hierarchy

Implements

Index

Constructors

constructor

Accessors

state

  • get state(): SharedWorkerConnector.State

Methods

close

  • close(): Promise<void>
  • Close connection.

    Close connection between the remote worker system.

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

    Returns Promise<void>

connect

  • connect(jsFile: string, ...args: string[]): Promise<void>
  • Connect to remote server.

    The connect() method tries to connect an SharedWorker instance. If the SharedWorker instance is not created yet, the SharedWorker instance would be newly created. After the creation, the SharedWorker program must open that server using the SharedWorkerServer.open() method.

    After you business has been completed, you've to close the SharedWorker using one of them below. If you don't close that, vulnerable memory usage and communication channel would not be destroyed and it may cause the memory leak:

    Parameters

    • jsFile: string

      JS File to be SharedWorkerServer.

    • Rest ...args: string[]

      Arguments to deliver.

    Returns Promise<void>

Protected destructor

  • destructor(error?: Error): Promise<void>
  • Destory the communicator.

    A destory function must be called when the network communication has been closed. It would destroy all function calls in the remote system (by Driver<Controller>), which are not returned yet.

    The error instance would be thrown to those function calls. If the disconnection is abnormal, then write the detailed reason why into the error instance.

    Parameters

    • Optional error: Error

      An error instance to be thrown to the unreturned functions.

    Returns Promise<void>

getDriver

  • getDriver<Controller, UseParametric>(): Driver<Controller, UseParametric>
  • Get Driver for RFC (Remote Function Call).

    The Controller is an interface who defines provided functions from the remote system. The Driver is an object who makes to call remote functions, defined in the Controller and provided by Provider in the remote system, possible.

    In other words, calling a functions in the Driver<Controller>, it means to call a matched function in the remote system's Provider object.

    • Controller: Definition only
    • Driver: Remote Function Call

    Type parameters

    • Controller: object

      An interface for provided features (functions & objects) from the remote system (Provider).

    • UseParametric: boolean

      Whether to convert type of function parameters to be compatible with their pritimive.

    Returns Driver<Controller, UseParametric>

    A Driver for the RFC.

getProvider

  • getProvider(): Provider | null
  • Get current Provider.

    Get an object providing features (functions & objects) for remote system. The remote system would call the features (Provider) by using its Driver<Controller>.

    Returns Provider | null

    Current Provider object

join

  • join(): Promise<void>
  • join(ms: number): Promise<boolean>
  • join(at: Date): Promise<boolean>

Protected replyData

  • replyData(invoke: Invoke): void
  • Data Reply Function.

    A function should be called when data has come from the remote system.

    When you receive a message from the remote system, then parse the message with your special protocol and covert it to be an Invoke object. After the conversion, call this method.

    Parameters

    • invoke: Invoke

      Structured data converted by your special protocol.

    Returns void

setProvider

  • setProvider(obj: Provider | null): void

Static compile

  • compile(content: string): string

Static remove

  • remove(url: string): void

Generated using TypeDoc