public.javadoc.org.spincast.core.websocket.WebsocketRoute.html Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spincast-website Show documentation

Source code for the https://www.spincast.org website.

There is a newer version: 2.2.0







WebsocketRoute (org.spincast:spincast-framework 1.0.0 API)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








org.spincast.core.websocket
Interface WebsocketRoute<R extends RequestContext<?>,W extends WebsocketContext<?>>






All Known Subinterfaces:
DefaultWebsocketRoute


All Known Implementing Classes:
SpincastWebsocketRoute




public interface WebsocketRoute<R extends RequestContext<?>,W extends WebsocketContext<?>>
A WebSocket route.











Method Summary

All Methods Instance Methods Abstract Methods 

Modifier and Type
Method and Description


List<Handler<R>>
getBeforeFilters()
The "before" filters, if any.



Set<String>
getFilterIdsToSkip()
The ids of the filters that should be skipped for this
 route.



String
getId()
The WebSocket route id.



String
getPath()
The WebSocket route path.



WebsocketController<R,W>
getWebsocketController()
The WebSocket controller to use.



boolean
isSpicastCoreRouteOrPluginRoute()
Is this a route added by Spincast itself
 or by a plugin? Otherwise, the route is
 considered as an application route.
















Method Detail





getId
String getId()
The WebSocket route id.







isSpicastCoreRouteOrPluginRoute
boolean isSpicastCoreRouteOrPluginRoute()
Is this a route added by Spincast itself
 or by a plugin? Otherwise, the route is
 considered as an application route.







getPath
String getPath()
The WebSocket route path.







getBeforeFilters
List<Handler<R>> getBeforeFilters()
The "before" filters, if any.







getWebsocketController
WebsocketController<R,W> getWebsocketController()
The WebSocket controller to use.







getFilterIdsToSkip
Set<String> getFilterIdsToSkip()
The ids of the filters that should be skipped for this
 route.













Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2019. All rights reserved.

Modifier and Type	Method and Description
`List<Handler<R>>`	`getBeforeFilters()` The "before" filters, if any.
`Set<String>`	`getFilterIdsToSkip()` The ids of the filters that should be skipped for this route.
`String`	`getId()` The WebSocket route id.
`String`	`getPath()` The WebSocket route path.
`WebsocketController<R,W>`	`getWebsocketController()` The WebSocket controller to use.
`boolean`	`isSpicastCoreRouteOrPluginRoute()` Is this a route added by Spincast itself or by a plugin? Otherwise, the route is considered as an application route.