Package org.jgroups.protocols
Interface Bundler
-
- All Known Implementing Classes:
AlternatingBundler
,BaseBundler
,BatchBundler
,NoBundler
,PerDestinationBundler
,RemoveQueueBundler
,RingBufferBundler
,RingBufferBundlerLockless
,RingBufferBundlerLockless2
,SenderSendsBundler
,TransferQueueBundler
public interface Bundler
Pluggable way to collect messages and send them as batches- Since:
- 4.0
- Author:
- Bela Ban
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default int
getCapacity()
If the bundler implementation supports a capacity (e.g.int
getMaxSize()
Maximum number of bytes for messages to be queued until they are sentint
getQueueSize()
If the bundler has a queue and it should be managed by a queuing discipline (like Random Early Detection), then return the number of elements in the queue, else -1.default void
init(TP transport)
Called after creation of the bundlerdefault void
renameThread()
default void
resetStats()
void
send(Message msg)
default Bundler
setMaxSize(int s)
int
size()
The number of unsent messages in the bundlervoid
start()
Called afterinit(TP)
void
stop()
default void
viewChange(View view)
-
-
-
Method Detail
-
init
default void init(TP transport)
Called after creation of the bundler- Parameters:
transport
- the transport, for further reference
-
start
void start()
Called afterinit(TP)
-
stop
void stop()
-
send
void send(Message msg) throws java.lang.Exception
- Throws:
java.lang.Exception
-
viewChange
default void viewChange(View view)
-
size
int size()
The number of unsent messages in the bundler
-
getQueueSize
int getQueueSize()
If the bundler has a queue and it should be managed by a queuing discipline (like Random Early Detection), then return the number of elements in the queue, else -1. In the latter case, the queue won't be managed.
This method needs to be fast as it might get called on every message to be sent.
-
getCapacity
default int getCapacity()
If the bundler implementation supports a capacity (e.g.RingBufferBundler
, then return it, else return -1
-
getMaxSize
int getMaxSize()
Maximum number of bytes for messages to be queued until they are sent
-
setMaxSize
default Bundler setMaxSize(int s)
-
renameThread
default void renameThread()
-
resetStats
default void resetStats()
-
-