Package io.continual.onap.services.publisher

Class OnapMsgRouterBatchPublisher

java.lang.Object

io.continual.onap.services.publisher.OnapMsgRouterBatchPublisher

All Implemented Interfaces:

Closeable, AutoCloseable

public class OnapMsgRouterBatchPublisher
extends Object
implements Closeable

A batching publisher for ONAP Message Router.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OnapMsgRouterBatchPublisher.Builder
static enum	OnapMsgRouterBatchPublisher.DropPolicy	What to do if the send buffer reaches maximum capacity

Method Summary

Modifier and Type	Method	Description
static OnapMsgRouterBatchPublisher	build(OnapMsgRouterPublisher pub, int atMost, int maxAgeMs)	For convenience, just provide a publisher and batching limits
void	close()	Close this publisher to stop its background sending thread.
OnapMsgRouterBatchPublisher	send(OnapMsgRouterPublisher.Message msg)	Queue a message to be sent in a batch.
OnapMsgRouterBatchPublisher	send(List<OnapMsgRouterPublisher.Message> msgs)	Queue a set of messages to be sent in a batch.
void	start()	Start the sending thread

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

build

public static OnapMsgRouterBatchPublisher build(OnapMsgRouterPublisher pub,
 int atMost,
 int maxAgeMs)

For convenience, just provide a publisher and batching limits

Parameters:

pub - an underlying publisher

atMost - how many messages to batch, at most

maxAgeMs - how long to wait before send, at most

Returns:

a batch publisher

start

public void start()

Start the sending thread

close

public void close()

Close this publisher to stop its background sending thread.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

send

public OnapMsgRouterBatchPublisher send(OnapMsgRouterPublisher.Message msg)

Queue a message to be sent in a batch.

Parameters:

msg - a message to send

Returns:

this

send

public OnapMsgRouterBatchPublisher send(List<OnapMsgRouterPublisher.Message> msgs)

Queue a set of messages to be sent in a batch. Iteration order is preserved in the send.

Parameters:

msgs - a list of messages to send

Returns:

this