org.rvpf.service.som

Interface SOMReceiver

All Superinterfaces:

SOMEndPoint

All Known Implementing Classes:

SOMReceiver.Client, SOMReceiver.Server

public interface SOMReceiver
extends SOMEndPoint

SOM receiver.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SOMReceiver.Client Client.
static class	SOMReceiver.Server Server.

Nested classes/interfaces inherited from interface SOMEndPoint

SOMEndPoint.Abstract

Method Summary

Modifier and Type	Method and Description
boolean	commit() Commits uncommitted messages.
Optional<QueueInfo>	getInfo() Gets the queue info.
long	purge() Purges the queue.
Serializable[]	receive(int limit, long timeout) Receives messages.
boolean	rollback() Rolls back uncommitted messages

Methods inherited from interface SOMEndPoint

close, getException, getServer, getServerURI, getSOMName, isClosed, isOpen, isRemote, isServer, open, tearDown

Method Detail

commit

@CheckReturnValue
boolean commit()

Commits uncommitted messages.

Returns:

True on success.

getInfo

@Nonnull
 @CheckReturnValue
Optional<QueueInfo> getInfo()

Gets the queue info.

Returns:

The queue info (empty on failure).

purge

@CheckReturnValue
long purge()

Purges the queue.

Returns:

The number of messages purged.

receive

@Nullable
 @CheckReturnValue
Serializable[] receive(int limit,
                                                      long timeout)

Receives messages.

Parameters:

limit - The maximum number of messages.

timeout - A time limit in millis to wait for the first message (negative for infinite).

Returns:

The messages (null on failure).

rollback

@CheckReturnValue
boolean rollback()

Rolls back uncommitted messages

Returns:

True on success.