Package com.vaadin.flow.server.communication.rpc

Interface RpcInvocationHandler

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractRpcInvocationHandler, AttachExistingElementRpcHandler, AttachTemplateChildRpcHandler, EventRpcHandler, MapSyncRpcHandler, NavigationRpcHandler, PublishedServerEventHandlerRpcHandler, ReturnChannelHandler

public interface RpcInvocationHandler
extends Serializable

RPC invocation handler interface.

Each instance must return unique rpc type (see getRpcType() and handle a JsonObject RPC data using handle(UI, JsonObject) method.

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

Since:

1.0

Author:

Vaadin Ltd

Method Summary

Modifier and Type	Method	Description
String	getRpcType()	Gets unique RPC type which this handler is applicable for.
Optional<Runnable>	handle(UI ui, elemental.json.JsonObject invocationJson)	Handles RPC data invocationJson using ui as a context.

Method Details

getRpcType

String getRpcType()

Gets unique RPC type which this handler is applicable for.

Returns:

the unique rpc type

handle

Optional<Runnable> handle(UI ui,
 elemental.json.JsonObject invocationJson)

Handles RPC data invocationJson using ui as a context.

Parameters:

ui - the UI to handle against, not null

invocationJson - the RPC data to handle, not null

Returns:

an optional runnable