com.vaadin.flow.server.
Interface StreamRegistration
All Superinterfaces:
Stream registration result.
Use getResourceUri()
to get URI after StreamResource
/
StreamReceiver
is registered.
Also allows resource unregistering.
Since:
1.0
Author:
Vaadin Ltd
-
Method Summary
Modifier and TypeMethodDescriptionGet the stream resource whose registration result is represented by this
StreamRegistration
instance.Get resource URI for registered
StreamResource
instance.void
Unregister
StreamResource
.
-
Method Details
-
getResourceUri
URI getResourceUri()Get resource URI for registered
StreamResource
instance.The URI is relative to the application base URI.
Returns:
resource URI
-
unregister
void unregister()Unregister
StreamResource
.The resource will be removed from the session and its URI won't be served by the application anymore so that the resource becomes available for GC.
It's the developer's responsibility to call this method at the appropriate time. Otherwise the resource instance will stay in memory until the session expires.
-
getResource
AbstractStreamResource getResource()Get the stream resource whose registration result is represented by this
StreamRegistration
instance.Returns:
resource, or null if resource has been already unregistered
-