类的使用
org.redkale.net.http.WebSocket

使用WebSocket的程序包

程序包	说明
org.redkale.boot	提供Redkale服务器的启动、初始化和加载功能
org.redkale.net.http	HTTP协议包,提供HTTP协议服务器

org.redkale.boot中WebSocket的使用

类型参数类型为WebSocket的org.redkale.boot中的字段

修饰符和类型	字段	说明
protected ClassFilter<? extends WebSocket>	NodeHttpServer.webSocketFilter

类型变量类型为WebSocket的org.redkale.boot中的方法参数

修饰符和类型	方法	说明
protected void	NodeHttpServer.loadRestServlet(ClassFilter<? extends WebSocket> webSocketFilter, AnyValue restConf, List<Object> restedObjects, ReentrantLock restedLock, StringBuilder sb, CopyOnWriteArrayList<AbstractMap.SimpleEntry<String,String[]>> rests, CopyOnWriteArrayList<AbstractMap.SimpleEntry<String,String[]>> webss)

org.redkale.net.http中WebSocket的使用

声明为WebSocket的org.redkale.net.http中的字段

修饰符和类型	字段	说明
protected WebSocket	WebSocketReadHandler.webSocket
protected WebSocket	WebSocketWriteHandler.webSocket

类型参数类型为WebSocket的org.redkale.net.http中的字段

修饰符和类型	字段	说明
protected BiConsumer<WebSocket,Object>	WebSocketReadHandler.restMessageConsumer

类型参数类型为WebSocket的org.redkale.net.http中的方法

修饰符和类型	方法	说明
<S extends WebSocket,T extends WebSocketServlet> T	HttpServer.addRestWebSocketServlet(ClassLoader classLoader, Class<S> webSocketType, MessageAgent messageAgent, String prefix, AnyValue conf)	添加WebSocketServlet
<T extends WebSocket> HttpServlet	HttpDispatcherServlet.removeHttpServlet(Class<T> websocketOrServletType)
<T extends WebSocket> HttpServlet	HttpServer.removeHttpServlet(Class<T> websocketOrServletType)	删除HttpServlet

返回WebSocket的org.redkale.net.http中的方法

修饰符和类型	方法	说明
protected abstract <G extends Serializable,T> WebSocket<G,T>	WebSocketServlet.createWebSocket()
protected WebSocket	WebSocket.findLocalWebSocket(G userid)	获取指定userid的WebSocket数组, 没有返回null 此方法用于单用户单连接模式
WebSocket	WebSocketEngine.findLocalWebSocket(Serializable userid)

返回变量类型为WebSocket的类型的org.redkale.net.http中的方法

修饰符和类型	方法	说明
protected BiConsumer<WebSocket,Object>	WebSocketServlet.createRestOnMessageConsumer()
protected Collection<WebSocket>	WebSocket.getLocalWebSockets()	获取当前进程节点所有在线的WebSocket
protected Stream<WebSocket>	WebSocket.getLocalWebSockets(G userid)	获取指定userid的WebSocket数组, 没有返回null 此方法用于单用户多连接模式
Collection<WebSocket>	WebSocketEngine.getLocalWebSockets()
Stream<WebSocket>	WebSocketEngine.getLocalWebSockets(Serializable userid)

参数类型为WebSocket的org.redkale.net.http中的方法

修饰符和类型	方法	说明
protected void	WebSocketServlet.initRestWebSocket(WebSocket websocket)

类型变量类型为WebSocket的org.redkale.net.http中的方法参数

修饰符和类型	方法	说明
CompletableFuture<Integer>	WebSocketEngine.broadcastLocalMessage(Predicate<WebSocket> predicate, Object message, boolean last)
static <T extends WebSocketServlet> T	Rest.createRestWebSocketServlet(ClassLoader classLoader, Class<? extends WebSocket> webSocketType, MessageAgent messageAgent)
void	WebSocketEngine.forEachLocalWebSocket(Consumer<WebSocket> consumer)

参数类型为WebSocket的org.redkale.net.http中的构造器

构造器	说明
WebSocketReadHandler(HttpContext context, WebSocket webSocket, ObjectPool<ByteArray> byteArrayPool, BiConsumer<WebSocket,Object> messageConsumer)
WebSocketWriteHandler(HttpContext context, WebSocket webSocket, ObjectPool<ByteArray> byteArrayPool)

类型变量类型为WebSocket的org.redkale.net.http中的构造器参数

构造器	说明
WebSocketReadHandler(HttpContext context, WebSocket webSocket, ObjectPool<ByteArray> byteArrayPool, BiConsumer<WebSocket,Object> messageConsumer)