Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebServer<Provider>

Web Socket Server.

  • available only in NodeJS.

The WebServer is a class who can open an websocket server. Clients connecting to the WebServer would communicate with this server through WebAcceptor objects using RFC (Remote Function Call).

To open the server, call the open() method with a callback function which would be called whenever a client has been connected.

author

Jeongho Nam http://samchon.org

Type parameters

  • Provider: object

    Type of features provided for remote systems.

Hierarchy

  • WebServer

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

state

  • get state(): WebServer.State

Methods

close

  • close(): Promise<void>

  • Close server.

    Close all connections between its remote clients (WebConnectors).

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

    Returns Promise<void>

open

  • open(port: number, handler: function): Promise<void>

  • Open websocket server.

    Parameters

    • port: number

      Port number to listen.

    • handler: function

      Callback function for client connection.

    Returns Promise<void>

Generated using TypeDoc