demus/openhab-core
1
0
Fork 0
mirror of https://github.com/danieldemus/openhab-core.git synced 2025-01-10 13:21:53 +01:00
Code Issues 1 Packages Projects Releases Wiki Activity

Complete sitemap subscriptions documentation correction (#4207)

Browse Source 
* update reference to method / parameter names from documentation
* reflect that subscriptions for a whole page are possible in the documentation
* document that subscriptions to a whole sitemap are possible but discouraged

Signed-off-by: Tassilo Karge <tassilo.karge@web.de>
This commit is contained in:
Tassilo Karge 2024-05-03 16:22:06 +02:00 committed by GitHub
parent 767cbd93d3
commit d9685ca9c0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
bundles/org.openhab.core.io.rest.sitemap/src/main/java/org/openhab/core/io/rest/sitemap/SitemapSubscriptionService.java
View File

@ -58,10 +58,11 @@ import org.slf4j.LoggerFactory;
/**
* This is a service that provides the possibility to manage subscriptions to sitemaps.
* As such subscriptions are stateful, they need to be created and removed upon disposal.
* The subscription mechanism makes sure that only events for widgets of the currently active sitemap page are sent as
* events to the subscriber.
* For this to work correctly, the subscriber needs to make sure that setPageId is called whenever it switches to a new
* page.
* The subscription mechanism makes sure that only events for widgets of the currently active sitemap or sitemap page
* are sent as events to the subscriber.
* For this to work correctly, the subscriber needs to make sure that {@link #updateSubscriptionLocation} is called
* whenever it switches to a new page, unless a subscription for the whole sitemap is made.
* Subscribing to whole sitemaps is discouraged, since a large number of item updates may result in a high SSE traffic.
*
* @author Kai Kreuzer - Initial contribution
*/
@ -234,7 +235,7 @@ public class SitemapSubscriptionService implements ModelRepositoryChangeListener
}
/**
* Updates the subscription to send events for the provided page id (or whole sitemap if pageId is null).
* Updates the subscription to send events for the provided page id (or whole sitemap if {@code pageId} is null).
*
* @param subscriptionId the subscription to update
* @param sitemapName the current sitemap name