diff options
| author | Arne Juul <arnej@verizonmedia.com> | 2021-07-13 12:37:21 +0000 |
|---|---|---|
| committer | Arne Juul <arnej@verizonmedia.com> | 2021-07-13 12:37:21 +0000 |
| commit | e8333f76c7c7437960b0a8c539584bb1a9af0897 (patch) | |
| tree | 29cd9ac58d3b5437e6d4636ca20589e2eb4adf97 | |
| parent | 6efebbe0b10420582eab1d0915ac99492a7be420 (diff) | |
add some minimal class documentation
| -rw-r--r-- | slobrok/src/vespa/slobrok/server/map_listener.h | 3 | ||||
| -rw-r--r-- | slobrok/src/vespa/slobrok/server/map_source.h | 3 | ||||
| -rw-r--r-- | slobrok/src/vespa/slobrok/server/proxy_map_source.h | 3 |
3 files changed, 9 insertions, 0 deletions
diff --git a/slobrok/src/vespa/slobrok/server/map_listener.h b/slobrok/src/vespa/slobrok/server/map_listener.h index cc99cfb58ac..e84f3bd5bd9 100644 --- a/slobrok/src/vespa/slobrok/server/map_listener.h +++ b/slobrok/src/vespa/slobrok/server/map_listener.h @@ -6,6 +6,9 @@ namespace slobrok { +/** + * Interface for getting incremental updates from a MapSource. + **/ struct MapListener { virtual void add(const ServiceMapping &mapping) = 0; virtual void remove(const ServiceMapping &mapping) = 0; diff --git a/slobrok/src/vespa/slobrok/server/map_source.h b/slobrok/src/vespa/slobrok/server/map_source.h index 63d97fa319f..7ba2a0ec4d6 100644 --- a/slobrok/src/vespa/slobrok/server/map_source.h +++ b/slobrok/src/vespa/slobrok/server/map_source.h @@ -6,6 +6,9 @@ namespace slobrok { +/** + * Interface for sources of incremental map updates. + **/ struct MapSource { virtual void registerListener(MapListener &listener) = 0; virtual void unregisterListener(MapListener &listener) = 0; diff --git a/slobrok/src/vespa/slobrok/server/proxy_map_source.h b/slobrok/src/vespa/slobrok/server/proxy_map_source.h index 1af347486fe..517c7150683 100644 --- a/slobrok/src/vespa/slobrok/server/proxy_map_source.h +++ b/slobrok/src/vespa/slobrok/server/proxy_map_source.h @@ -7,6 +7,9 @@ namespace slobrok { +/** + * Proof-of-concept implementation of MapSource broadcasting. + **/ class ProxyMapSource : public MapSource, public MapListener { std::set<MapListener *> _listeners; public: |