API Docs for: 0.8.0
Show:

ServerInitializer Class

Defined in: include/http/server_initializer.js:25
Module: ErrorSuccess

Creates and initializes the HTTP server

Constructor

ServerInitializer

(
  • [pb]
)

Defined in include/http/server_initializer.js:25

Parameters:

  • [pb] Object optional

    The PB object

Methods

_init

(
  • context
  • cb
)
private

Defined in include/http/server_initializer.js:53

Parameters:

  • context Object
    • log Logger
    • config Object

      The PB config object

    • onRequest Function

      Takes 2 parameters: req, res

    • [onHandOffRequest] Function optional

      Takes 2 parameters: req, res. It is required if starting with SSL enabled

  • cb Function

getServer

(
  • context
)

Defined in include/http/server_initializer.js:128

Parameters:

  • context Object
    • onRequest Function

      Takes 2 parameters: req, res return {HttpServer}

getSslServer

(
  • context
)
HttpsServer

Defined in include/http/server_initializer.js:138

Parameters:

  • context Object
    • config Object

      The PB config object

    • onRequest Object

      Takes 2 parameters: req, res

Returns:

HttpsServer:

getSslServerOptions

(
  • config
)
Object

Defined in include/http/server_initializer.js:150

Parameters:

  • config Object
    • server Object
      • ssl Object
      • ssl.key String
      • ssl.cert String
      • ssl.chain String

Returns:

Object:

init

(
  • context
  • cb
)

Defined in include/http/server_initializer.js:33

Initializes the server. Depending on the configuration will start an HTTP server and/or an HTTPs server.

Parameters:

  • context Object
    • log Logger
    • config Object

      The PB config object

    • onRequest Function

      Takes 2 parameters: req, res

    • [onHandOffRequest] Function optional

      Takes 2 parameters: req, res. It is required if starting with SSL enabled

  • cb Function

initHttp

(
  • context
  • cb
)

Defined in include/http/server_initializer.js:68

Parameters:

  • context Object
    • log Logger
    • config Object

      The PB config object

    • onRequest Function

      Takes 2 parameters: req, res

  • cb Function

initHttps

(
  • context
  • cb
)

Defined in include/http/server_initializer.js:86

Parameters:

  • context Object
    • log Logger
    • config Object

      The PB config object

    • onRequest Function

      Takes 2 parameters: req, res

    • onHandOffRequest Function

      Takes 2 parameters: req, res

  • cb Function

startServer

(
  • server
  • port
  • ip
  • cb
)

Defined in include/http/server_initializer.js:175

Does a simple start on a server object by binding to the specified IP address and port.

Parameters:

  • server HttpServer | HttpsServer
  • port Integer
  • ip String
  • cb Function