---
lang: en
title: 'API docs: socketio.socketioserver'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/socketio
permalink: /doc/en/lb4/apidocs.socketio.socketioserver.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/socketio](./socketio.md) &gt; [SocketIoServer](./socketio.socketioserver.md)

## SocketIoServer class

A socketio server

**Signature:**

```typescript
export declare class SocketIoServer extends Context 
```
**Extends:** [Context](./context.context.md)

## Constructors

<table><thead><tr><th>

Constructor


</th><th>

Modifiers


</th><th>

Description


</th></tr></thead>
<tbody><tr><td markdown="1">

[(constructor)(app, options)](./socketio.socketioserver._constructor_.md)


</td><td markdown="1">


</td><td markdown="1">

Constructs a new instance of the `SocketIoServer` class


</td></tr>
</tbody></table>

## Properties

<table><thead><tr><th>

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td markdown="1">

[app](./socketio.socketioserver.app.md)


</td><td markdown="1">


</td><td markdown="1">

[Application](./core.application.md)


</td><td markdown="1">


</td></tr>
<tr><td markdown="1">

[config](./socketio.socketioserver.config.md)


</td><td markdown="1">

`readonly`


</td><td markdown="1">

[HttpServerResolvedOptions](./socketio.httpserverresolvedoptions.md)


</td><td markdown="1">


</td></tr>
<tr><td markdown="1">

[listening](./socketio.socketioserver.listening.md)


</td><td markdown="1">

`readonly`


</td><td markdown="1">

boolean


</td><td markdown="1">


</td></tr>
<tr><td markdown="1">

[options](./socketio.socketioserver.options.md)


</td><td markdown="1">

`protected`


</td><td markdown="1">

[SocketIoServerOptions](./socketio.socketioserveroptions.md)


</td><td markdown="1">


</td></tr>
<tr><td markdown="1">

[url](./socketio.socketioserver.url.md)


</td><td markdown="1">

`readonly`


</td><td markdown="1">

string


</td><td markdown="1">


</td></tr>
</tbody></table>

## Methods

<table><thead><tr><th>

Method


</th><th>

Modifiers


</th><th>

Description


</th></tr></thead>
<tbody><tr><td markdown="1">

[controller(controllerClass)](./socketio.socketioserver.controller.md)


</td><td markdown="1">


</td><td markdown="1">

Register a socket.io controller


</td></tr>
<tr><td markdown="1">

[discoverAndRegister()](./socketio.socketioserver.discoverandregister.md)


</td><td markdown="1">


</td><td markdown="1">

Discover all socket.io controllers and register routes


</td></tr>
<tr><td markdown="1">

[route(controllerClass, meta)](./socketio.socketioserver.route.md)


</td><td markdown="1">


</td><td markdown="1">

Register a socketio controller


</td></tr>
<tr><td markdown="1">

[start()](./socketio.socketioserver.start.md)


</td><td markdown="1">


</td><td markdown="1">

Start the socketio server


</td></tr>
<tr><td markdown="1">

[stop()](./socketio.socketioserver.stop.md)


</td><td markdown="1">


</td><td markdown="1">

Stop the socketio server


</td></tr>
<tr><td markdown="1">

[use(fn)](./socketio.socketioserver.use.md)


</td><td markdown="1">


</td><td markdown="1">

Register a sock.io middleware function


</td></tr>
</tbody></table>