Page Contents
Home > @loopback/socketio > SocketIoServer
SocketIoServer class
A socketio server
Signature:
export declare class SocketIoServer extends Context
Extends: Context
Constructors
Constructor | Modifiers | Description |
---|---|---|
(constructor)(app, options) | Constructs a new instance of the SocketIoServer class |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
app | Application | ||
config | readonly |
HttpServerResolvedOptions | |
listening | readonly |
boolean | |
options | protected |
SocketIoServerOptions | |
url | readonly |
string |
Methods
Method | Modifiers | Description |
---|---|---|
controller(controllerClass) | Register a socket.io controller | |
discoverAndRegister() | Discover all socket.io controllers and register routes | |
route(controllerClass, meta) | Register a socketio controller | |
start() | Start the socketio server | |
stop() | Stop the socketio server | |
use(fn) | Register a sock.io middleware function |