Class AkeraServer

Hierarchy

AkeraServer

Index

Accessors

Methods

Accessors

logger

set logger(oLogger: AkeraLogger): void

Set the instance level logger.

Parameters
- oLogger: AkeraLogger
  
  The logger to use for the server instance.
Returns void

ssl

get ssl(): boolean

Returns true if the server is requiring secure SSL connections.

Returns boolean

Static logger

set logger(oLogger: AkeraLogger): void

Set the default logger used by all instances unless one set at instance level.

Parameters
- oLogger: AkeraLogger
  
  The logger to use as default for all server instances.
Returns void

Methods

close

close(timeout?: number): Promise<void>

Stop listenning for incomming conections.

Parameters
- Optional timeout: number
Returns Promise<void>

listen

listen(port?: number, host?: string, timeout?: number): Promise<void>

Start listening for incomming connections.

Parameters
- Optional port: number
  
  The port number to listen on for incomming connections.
- Optional host: string
- Optional timeout: number
Returns Promise<void>

Static create

create(onConnect: function, sslOptions?: TlsOptions): AkeraServer

This creates a server socket that returns an AkeraConnection wrapped on top of each client socket on each connection to make it easier to communicate using the akera.io protocol.

Parameters
- onConnect: function
  
  The on-connect handler that will receive an AkeraConnection as input.
  - - (connection: AkeraConnection): void
    - Parameters
      - connection: AkeraConnection
      Returns void
- Optional sslOptions: TlsOptions
Returns AkeraServer