Nexus API Reference
CompiledWsApplication
in package
implements
CompiledApplication
Read onlyYes
FinalYes
Tags
Table of Contents
Interfaces
Methods
- __construct() : mixed
- container() : ContainerInterface
- dispatcher() : WebSocketDispatcher
- handle() : ResponseInterface
- handshakeGate() : HandshakeGate
- The pre-upgrade authorization gate servers must consult before completing the WebSocket handshake. Applications compiled without an explicit gate get a middleware-free gate over the same router: unmatched paths are still rejected with 404 before the 101 switch.
- hasWebSocketRoutes() : bool
- webSocketRouter() : WebSocketRouter
Methods
__construct()
public
__construct(CompiledHttpApp $http, WebSocketRouter $router, WebSocketDispatcher $dispatcher, ContainerInterface $container[, HandshakeGate|null $handshakeGate = null ]) : mixed
Parameters
- $http : CompiledHttpApp
- $router : WebSocketRouter
- $dispatcher : WebSocketDispatcher
- $container : ContainerInterface
- $handshakeGate : HandshakeGate|null = null
container()
public
container() : ContainerInterface
Return values
ContainerInterfacedispatcher()
public
dispatcher() : WebSocketDispatcher
Return values
WebSocketDispatcherhandle()
public
handle(ServerRequestInterface $request) : ResponseInterface
Parameters
- $request : ServerRequestInterface
Attributes
- #[Override]
Return values
ResponseInterfacehandshakeGate()
The pre-upgrade authorization gate servers must consult before completing the WebSocket handshake. Applications compiled without an explicit gate get a middleware-free gate over the same router: unmatched paths are still rejected with 404 before the 101 switch.
public
handshakeGate() : HandshakeGate
Return values
HandshakeGatehasWebSocketRoutes()
public
hasWebSocketRoutes() : bool
Attributes
- #[Override]
Return values
boolwebSocketRouter()
public
webSocketRouter() : WebSocketRouter