Package com.vaadin.flow.server.communication

Class RpcInvocationEvent

java.lang.Object

java.util.EventObject

com.vaadin.flow.server.communication.AbstractRpcInvocationEvent

com.vaadin.flow.server.communication.RpcInvocationEvent

All Implemented Interfaces:

Serializable

@Deprecated(since="25.3",
            forRemoval=true)
public class RpcInvocationEvent
extends AbstractRpcInvocationEvent

Deprecated, for removal: This API element is subject to removal in a future version.

use RpcInvocationStartedEvent, RpcInvocationFailedEvent and RpcInvocationEndedEvent on the service event bus instead

Event fired to RpcInvocationListeners around the server-side handling of a single client-to-server RPC invocation (a DOM event, a synchronized property update, a @ClientCallable/template event handler, a server-side navigation, a return channel message, and so on).

A client request can carry several invocations; one event is fired per invocation. The RpcInvocationListener.invocationStarted(com.vaadin.flow.server.communication.RpcInvocationEvent), (optional) RpcInvocationListener.invocationFailed(com.vaadin.flow.server.communication.RpcInvocationEvent, java.lang.Throwable) and RpcInvocationListener.invocationEnded(com.vaadin.flow.server.communication.RpcInvocationEvent) callbacks for a single invocation are delivered on the same thread, so timing state can be kept in a thread local.

Since:

25.2

See Also:

• RpcInvocationListener
• Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
RpcInvocationEvent(UI ui, String type, int nodeId, String name)	Deprecated, for removal: This API element is subject to removal in a future version. Creates a new RPC invocation event.

Method Summary

Methods inherited from class com.vaadin.flow.server.communication.AbstractRpcInvocationEvent

getName, getNodeId, getType, getUI

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Details

RpcInvocationEvent

public RpcInvocationEvent(UI ui,
 String type,
 int nodeId,
 String name)

Deprecated, for removal: This API element is subject to removal in a future version.

Creates a new RPC invocation event.

Parameters:

ui - the UI the invocation is handled against, not null

type - the protocol-level invocation type (for example event, mSync, publishedEventHandler, navigation, channel), not null

nodeId - the id of the targeted StateNode, or -1 if the invocation does not target a node

name - a human-readable identifier for the invocation (the DOM event name, the synchronized property name, the invoked method name, the navigation location, ...), or null if none applies