Package com.vaadin.flow.server.communication

Class ReturnChannelHandler

java.lang.Object

com.vaadin.flow.server.communication.rpc.AbstractRpcInvocationHandler

com.vaadin.flow.server.communication.ReturnChannelHandler

All Implemented Interfaces:

RpcInvocationHandler, Serializable

public class ReturnChannelHandler
extends AbstractRpcInvocationHandler

RPC handler for return channel messages.

For internal use only. May be renamed or removed in a future release.

Since:

2.0

Author:

Vaadin Ltd

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ReturnChannelHandler()

Method Summary

Modifier and Type	Method	Description
protected boolean	allowInert(UI ui, elemental.json.JsonObject invocationJson)	Specifies whether inert status should be ignored for an RPC invocation or not.
String	getRpcType()	Gets unique RPC type which this handler is applicable for.
protected Optional<Runnable>	handleNode(StateNode node, elemental.json.JsonObject invocationJson)	Handle the RPC data invocationJson using target node as a context.

Methods inherited from class com.vaadin.flow.server.communication.rpc.AbstractRpcInvocationHandler

getNodeId, handle

Methods inherited from class java.lang.Object

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

Constructor Detail

ReturnChannelHandler

public ReturnChannelHandler()

Method Detail

getRpcType

public String getRpcType()

Description copied from interface: RpcInvocationHandler

Gets unique RPC type which this handler is applicable for.

Returns:

the unique rpc type

handleNode

protected Optional<Runnable> handleNode(StateNode node,
                                        elemental.json.JsonObject invocationJson)

Description copied from class: AbstractRpcInvocationHandler

Handle the RPC data invocationJson using target node as a context.

Specified by:

handleNode in class AbstractRpcInvocationHandler

Parameters:

node - node to handle invocation with, not null

invocationJson - the RPC data to handle, not null

Returns:

an optional runnable

allowInert

protected boolean allowInert(UI ui,
                             elemental.json.JsonObject invocationJson)

Description copied from class: AbstractRpcInvocationHandler

Specifies whether inert status should be ignored for an RPC invocation or not. The default behaviour is to let the polling events be handled, while ignoring other requests.

Overrides:

allowInert in class AbstractRpcInvocationHandler

Parameters:

ui - the UI instance that RPC invocation originated from.

invocationJson - the JsonObject containing invocation properties.

Returns:

a boolean indicating that the inert status should be ignored for the current invocation or not.