From b2625a4cc10baf5b2a85632113b46fbd70da0aab Mon Sep 17 00:00:00 2001 From: Ankit Gupta Date: Sun, 29 Jun 2014 07:52:27 -0700 Subject: [PATCH] Add java docs for StatsCollector constructor and StatsCollectorCallback thread safety --- java/org/rocksdb/StatisticsCollector.java | 7 +++++++ java/org/rocksdb/StatisticsCollectorCallback.java | 7 +++++++ 2 files changed, 14 insertions(+) diff --git a/java/org/rocksdb/StatisticsCollector.java b/java/org/rocksdb/StatisticsCollector.java index eb3121a12..059e63cb5 100644 --- a/java/org/rocksdb/StatisticsCollector.java +++ b/java/org/rocksdb/StatisticsCollector.java @@ -26,6 +26,13 @@ public class StatisticsCollector { private final StatisticsCollectorCallback _statsCallback; private volatile boolean _isRunning = true; + /** + * Constructor for statistics collector. + * @param statistics Reference of DB statistics. + * @param statsCollectionIntervalInMilliSeconds Statistics collection time + * period (specified in milliseconds) + * @param statsCallback Reference of statistics callback interface. + */ public StatisticsCollector(Statistics statistics, int statsCollectionIntervalInMilliSeconds, StatisticsCollectorCallback statsCallback) { diff --git a/java/org/rocksdb/StatisticsCollectorCallback.java b/java/org/rocksdb/StatisticsCollectorCallback.java index a2630db36..d50b109d2 100644 --- a/java/org/rocksdb/StatisticsCollectorCallback.java +++ b/java/org/rocksdb/StatisticsCollectorCallback.java @@ -7,6 +7,13 @@ package org.rocksdb; /** * Callback interface provided to StatisticsCollector. + * + * Thread safety: + * StatisticsCollector doesn't make any guarantees about thread safety. + * If the same reference of StatisticsCollectorCallback is passed to multiple + * StatisticsCollector references, then its the responsibility of the + * user to make StatisticsCollectorCallback' implementation thread-safe. + * * @param tickerType * @param tickerCount */ -- GitLab