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

Class PublishedServerEventHandlerRpcHandler

java.lang.Object
com.vaadin.flow.server.communication.rpc.AbstractRpcInvocationHandler
com.vaadin.flow.server.communication.rpc.PublishedServerEventHandlerRpcHandler
All Implemented Interfaces:
RpcInvocationHandler, Serializable
public class PublishedServerEventHandlerRpcHandler extends AbstractRpcInvocationHandler
RPC handler for events triggered through element.$server or simply $server in template event handlers.

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

Since:
1.0
Author:
Vaadin Ltd
See Also:

  • Constructor Details

    • PublishedServerEventHandlerRpcHandler

      public PublishedServerEventHandlerRpcHandler()

  • Method Details

    • getRpcType

      public String getRpcType()
      Description copied from interface: RpcInvocationHandler
      Gets unique RPC type which this handler is applicable for.
      Returns:
      the unique rpc type

    • 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.

    • handleNode

      public 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