Skip to content

Commit d1648aa

Browse files
committed
Specify filter size is in bytes
1 parent fa0e218 commit d1648aa

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

src/main/java/com/rabbitmq/stream/StreamCreator.java

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,15 @@ public interface StreamCreator {
6767
/**
6868
* Set the size of the stream chunk filters.
6969
*
70-
* @param size
70+
* <p>Must be between 16 and 255 bytes, default is 16.
71+
*
72+
* <p>Use a bloom filter calculator to size the filter accordingly to the possible number of
73+
* filter values and the acceptable rate of false positives (RabbitMQ Stream uses 2 hash
74+
* functions).
75+
*
76+
* @param size (in bytes)
7177
* @return this creator instance
72-
* @see ProducerBuilder#filterValue( Function)
78+
* @see ProducerBuilder#filterValue(Function)
7379
* @see ConsumerBuilder#filter()
7480
*/
7581
StreamCreator filterSize(int size);

0 commit comments

Comments
 (0)