@loopback/docs
Version:
Documentation files rendered at [https://loopback.io](https://loopback.io)
239 lines (108 loc) • 3.54 kB
Markdown
---
lang: en
title: 'API docs: socketio.socketiocontrollerfactory'
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.socketiocontrollerfactory.html
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@loopback/socketio](./socketio.md) > [SocketIoControllerFactory](./socketio.socketiocontrollerfactory.md)
## SocketIoControllerFactory class
A factory to instantiate socket.io controllers
**Signature:**
```typescript
export declare class SocketIoControllerFactory
```
## Constructors
<table><thead><tr><th>
Constructor
</th><th>
Modifiers
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[(constructor)(parentCtx, controllerClass, socket)](./socketio.socketiocontrollerfactory._constructor_.md)
</td><td markdown="1">
</td><td markdown="1">
Constructs a new instance of the `SocketIoControllerFactory` 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">
[connCtx](./socketio.socketiocontrollerfactory.connctx.md)
</td><td markdown="1">
`readonly`
</td><td markdown="1">
[SocketIoConnectionContext](./socketio.socketioconnectioncontext.md)
</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">
[connect()](./socketio.socketiocontrollerfactory.connect.md)
</td><td markdown="1">
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[create()](./socketio.socketiocontrollerfactory.create.md)
</td><td markdown="1">
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[getAllMethodMetadataForKey(metadataAccessor)](./socketio.socketiocontrollerfactory.getallmethodmetadataforkey.md)
</td><td markdown="1">
`protected`
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[getCallback(methodName)](./socketio.socketiocontrollerfactory.getcallback.md)
</td><td markdown="1">
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[getDecoratedMethodsForConnect()](./socketio.socketiocontrollerfactory.getdecoratedmethodsforconnect.md)
</td><td markdown="1">
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[getDecorateSubscribeMethods()](./socketio.socketiocontrollerfactory.getdecoratesubscribemethods.md)
</td><td markdown="1">
`protected`
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[getDecorateSubscribeMethodsByEventName()](./socketio.socketiocontrollerfactory.getdecoratesubscribemethodsbyeventname.md)
</td><td markdown="1">
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[registerSubscribeMethods()](./socketio.socketiocontrollerfactory.registersubscribemethods.md)
</td><td markdown="1">
`protected`
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[setup()](./socketio.socketiocontrollerfactory.setup.md)
</td><td markdown="1">
</td><td markdown="1">
Set up the controller for the given socket
</td></tr>
</tbody></table>