Module: Feature_SocketServer middleware: (packet, next) =>

Socket based Rpc Server

Source:
appFeatures/socketServer.js

Members


<static> type :string

This feature is loaded at plugin stage

Type:
  • string
Source:
appFeatures/socketServer.js

Methods


<static> load_(appModule, servers)

Load the rpc Server

Parameters:
Name Type Description
appModule AppModule

The app module object

servers Array.<ServerOptions>

Rpc server config

Source:
appFeatures/socketServer.js

Type Definitions


ServerOptions

The socket server options.

Type:
  • Object
Properties:
Name Type Argument Default Description
path string <optional>
/socket.io

name of the path to capture

serveClient boolean <optional>
true

whether to serve the client files

adapter Adapter

the adapter to use. Defaults to an instance of the Adapter that ships with socket.io which is memory based. See socket.io-adapter

origins string

the allowed origins

parser Parser

the parser to use. Defaults to an instance of the Parser that ships with socket.io. See socket.io-parser

Source:
appFeatures/socketServer.js
See: