com.vaadin.flow.server.communication.
Interface PushConnection
-
All Superinterfaces:
All Known Implementing Classes:
public interface PushConnection extends Serializable
Represents a bidirectional ("push") connection between a single UI and its client-side. A single
PushConnection
instance is bound to a UI as long as push is enabled in that UI, even if the actual connection is momentarily dropped either due to a network failure or as a normal part of the transport mechanism.This interface is an internal API, only meant to be used by the framework.
Since:
1.0
Author:
Vaadin Ltd
-
-
Method Summary
All Methods Modifier and Type Method and Description void
disconnect()
Closes the connection.
boolean
isConnected()
Returns whether this connection is currently open.
void
push()
Pushes pending state changes and client RPC calls to the client.
-
-
-
Method Detail
-
push
void push()
Pushes pending state changes and client RPC calls to the client. Can be called even if
isConnected()
is false; the push will be deferred until a connection is available. It is NOT safe to invoke this method if not holding the session lock.This is internal API; please use
UI.push()
instead.
-
disconnect
void disconnect()
Closes the connection. Cannot be called if
isConnected()
is false.
-
isConnected
boolean isConnected()
Returns whether this connection is currently open.
Returns:
true if the connection is open, false otherwise
-
-