org.dromara.soul.web.plugin.function

类 WebSocketPlugin

java.lang.Object

org.dromara.soul.web.plugin.AbstractSoulPlugin

org.dromara.soul.web.plugin.function.WebSocketPlugin

所有已实现的接口:

SoulPlugin

public class WebSocketPlugin
extends AbstractSoulPlugin

The type Web socket plugin.

作者:

xiaoyu(Myth)

构造器概要

构造器

构造器和说明
WebSocketPlugin(LocalCacheManager localCacheManager, UpstreamCacheManager upstreamCacheManager, org.springframework.web.reactive.socket.client.WebSocketClient webSocketClient, org.springframework.web.reactive.socket.server.WebSocketService webSocketService) Instantiates a new Web socket plugin.

方法概要

限定符和类型	方法和说明
protected reactor.core.publisher.Mono<Void>	doExecute(org.springframework.web.server.ServerWebExchange exchange, SoulPluginChain chain, SelectorData selector, RuleData rule) this is Template Method child has Implement your own logic.
int	getOrder() return plugin order .
String	named() acquire plugin name.
PluginTypeEnum	pluginType() return plugin type.
Boolean	skip(org.springframework.web.server.ServerWebExchange exchange) plugin is execute.

从类继承的方法 org.dromara.soul.web.plugin.AbstractSoulPlugin

execute

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

WebSocketPlugin

public WebSocketPlugin(LocalCacheManager localCacheManager,
                       UpstreamCacheManager upstreamCacheManager,
                       org.springframework.web.reactive.socket.client.WebSocketClient webSocketClient,
                       org.springframework.web.reactive.socket.server.WebSocketService webSocketService)

Instantiates a new Web socket plugin.

参数:

localCacheManager - the local cache manager

upstreamCacheManager - the upstream cache manager

webSocketClient - the web socket client

webSocketService - the web socket service

方法详细资料

doExecute

protected reactor.core.publisher.Mono<Void> doExecute(org.springframework.web.server.ServerWebExchange exchange,
                                                      SoulPluginChain chain,
                                                      SelectorData selector,
                                                      RuleData rule)

从类复制的说明: AbstractSoulPlugin

this is Template Method child has Implement your own logic.

指定者:

doExecute 在类中 AbstractSoulPlugin

参数:

exchange - exchange the current server exchange ServerWebExchange

chain - chain the current chain ServerWebExchange

selector - selector SelectorData

rule - rule RuleData

返回:

Mono<Void> to indicate when request handling is complete

named

public String named()

从接口复制的说明: SoulPlugin

acquire plugin name. this is plugin name define if you extend AbstractSoulPlugin you must Provide the right name. if you impl AbstractSoulPlugin this attribute not use.

返回:

plugin name.

skip

public Boolean skip(org.springframework.web.server.ServerWebExchange exchange)

plugin is execute.

参数:

exchange - the current server exchange

返回:

default false.

pluginType

public PluginTypeEnum pluginType()

return plugin type.

返回:

PluginTypeEnum

getOrder

public int getOrder()

从接口复制的说明: SoulPlugin

return plugin order . This attribute To determine the plugin execution order in the same type plugin.

返回:

int order