io.continual.messaging

Interface ContinualMessageSink

public interface ContinualMessageSink

A generalized destination for messages, which are optionally sent as part of a specific message stream.

Field Summary

Fields

Modifier and Type	Field and Description
static String	kGeneralMessageStreamName The conventional general message stream name.
static ContinualMessageStream	kGeneralMsgStream a standard message stream from the conventional general message stream name.

Method Summary

Modifier and Type	Method and Description
default void	send(Collection<ContinualMessage> msgs) Send a list of messages to the sink using its general message stream.
default void	send(ContinualMessage... msgs) Send a list of messages to the sink using its general message stream.
default void	send(ContinualMessage msg) Send a message to the sink using its general message stream.
void	send(ContinualMessageStream stream, Collection<ContinualMessage> msgs) Send a collection (iterated in order) of messages to the sink using the given message stream.
default void	send(ContinualMessageStream stream, ContinualMessage... msgs) Send a list of messages to the sink using the given message stream.
default void	send(ContinualMessageStream stream, ContinualMessage message) Send a message to the sink using the given message stream.

Field Detail

kGeneralMessageStreamName

static final String kGeneralMessageStreamName

The conventional general message stream name. Messages sent in this stream can be processed in any order.

See Also:

Constant Field Values

kGeneralMsgStream

static final ContinualMessageStream kGeneralMsgStream

a standard message stream from the conventional general message stream name.

Method Detail

send

default void send(ContinualMessage msg)
           throws MessagePublishException

Send a message to the sink using its general message stream.

Parameters:

msg - a message

Throws:

MessagePublishException - when a message cannot be published

send

default void send(ContinualMessage... msgs)
           throws MessagePublishException

Send a list of messages to the sink using its general message stream.

Parameters:

msgs - messages

Throws:

MessagePublishException - when a message cannot be published

send

default void send(Collection<ContinualMessage> msgs)
           throws MessagePublishException

Send a list of messages to the sink using its general message stream.

Parameters:

msgs - messages

Throws:

MessagePublishException - when a message cannot be published

send

default void send(ContinualMessageStream stream,
                  ContinualMessage message)
           throws MessagePublishException

Send a message to the sink using the given message stream.

Parameters:

stream - a stream

message - a message

Throws:

MessagePublishException - when a message cannot be published

send

default void send(ContinualMessageStream stream,
                  ContinualMessage... msgs)
           throws MessagePublishException

Send a list of messages to the sink using the given message stream.

Parameters:

stream - a stream

msgs - messages

Throws:

MessagePublishException - when a message cannot be published

send

void send(ContinualMessageStream stream,
          Collection<ContinualMessage> msgs)
   throws MessagePublishException

Send a collection (iterated in order) of messages to the sink using the given message stream.

Parameters:

stream - a stream

msgs - messsages

Throws:

MessagePublishException - when a message cannot be published