• Public
  • Public/Protected
  • All

Class WorkerServer<Provider>

Worker Server.

The WorkerServer is a class representing a Worker server who can communicate with remote client, parent and creator of the Worker (anyway WorkerConnector), using RFC (Remote Function Call).

Unlike other servers, WorkerServer can accept only a client (WorkerConnector) because the worker is dependent on its parent instance (web page, node or parent worker). Thus, WorkerServer does not have any acceptor and communicates with client (its parent) by itself.

To start communication with the remote client, call the open() method with special Provider. After your business, don't forget terminating this worker using close() or WorkerConnector.close() method. If you don't terminate it, then vulnerable memory and communication channel would be kept and it may cause the memory leak.


Jeongho Nam http://samchon.org

Type parameters

  • Provider: object

    Type of features provided for remote system.








  • get arguments(): string[]


  • get state(): WorkerServer.State



  • 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>

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.


    • Optional error: Error

      An error instance to be thrown to the unreturned functions.

    Returns Promise<void>


  • 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(): Provider | null | undefined
  • 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 | undefined

    Current Provider object


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


  • open(provider?: Provider | null): Promise<void>
  • Open server with Provider.

    Open worker server and start communication with the remote system (WorkerConnector).

    Note that, after your business, you should terminate this worker to prevent waste of memory leak. Close this worker by yourself (close) or let remote client to close this worker (WorkerConnector.close).


    • Default value provider: Provider | null = null

      An object providing featrues for the remote system.

    Returns Promise<void>

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.


    • invoke: Invoke

      Structured data converted by your special protocol.

    Returns void


  • setProvider(obj: Provider | null | undefined): void

Generated using TypeDoc