org.rvpf.service.som

Class SOMReceiver.Client

Object

SOMEndPoint.Abstract

SOMReceiver.Client

All Implemented Interfaces:

SOMEndPoint, SOMReceiver

Enclosing interface:

SOMReceiver

public static final class SOMReceiver.Client
extends SOMEndPoint.Abstract
implements SOMReceiver

Client.

Nested Class Summary

Nested classes/interfaces inherited from interface SOMReceiver

SOMReceiver.Client, SOMReceiver.Server

Nested classes/interfaces inherited from interface SOMEndPoint

SOMEndPoint.Abstract

Method Summary

Modifier and Type	Method and Description
void	close() Closes.
boolean	commit() Commits uncommitted messages.
Optional<QueueInfo>	getInfo() Gets the queue info.
Optional<SOMServerImpl>	getServer() Gets the server.
Optional<URI>	getServerURI() Gets the server URI.
String	getSOMName() Gets the SOM name.
boolean	isClosed() Asks if closed.
boolean	isOpen() Asks if open.
boolean	isRemote() Asks if remote.
boolean	isServer() Asks if server.
boolean	open() Opens.
long	purge() Purges the queue.
Serializable[]	receive(int limit, long timeout) Receives messages.
boolean	rollback() Rolls back uncommitted messages
void	tearDown() Tears down.
String	toString()

Methods inherited from class SOMEndPoint.Abstract

clearException, getException, setException

Methods inherited from class Object

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

Methods inherited from interface SOMEndPoint

getException

Method Detail

close

public void close()

Closes.

Specified by:

close in interface SOMEndPoint

commit

public boolean commit()

Commits uncommitted messages.

Specified by:

commit in interface SOMReceiver

Returns:

True on success.

getInfo

public Optional<QueueInfo> getInfo()

Gets the queue info.

Specified by:

getInfo in interface SOMReceiver

Returns:

The queue info (empty on failure).

getSOMName

public String getSOMName()

Gets the SOM name.

Specified by:

getSOMName in interface SOMEndPoint

Returns:

The SOM name.

getServer

public Optional<SOMServerImpl> getServer()

Gets the server.

Specified by:

getServer in interface SOMEndPoint

Returns:

The server implementation (empty when client).

getServerURI

public Optional<URI> getServerURI()

Gets the server URI.

Specified by:

getServerURI in interface SOMEndPoint

Returns:

The server URI (empty when server).

isClosed

public boolean isClosed()

Asks if closed.

Specified by:

isClosed in interface SOMEndPoint

Returns:

True if closed.

isOpen

public boolean isOpen()

Asks if open.

Specified by:

isOpen in interface SOMEndPoint

Returns:

True if open.

isRemote

public boolean isRemote()

Asks if remote.

Specified by:

isRemote in interface SOMEndPoint

Returns:

True if remote.

isServer

public boolean isServer()

Asks if server.

Specified by:

isServer in interface SOMEndPoint

Returns:

True if server.

open

public boolean open()

Opens.

Specified by:

open in interface SOMEndPoint

Returns:

True on success.

purge

public long purge()

Purges the queue.

Specified by:

purge in interface SOMReceiver

Returns:

The number of messages purged.

receive

public Serializable[] receive(int limit,
                              long timeout)

Receives messages.

Specified by:

receive in interface SOMReceiver

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

public boolean rollback()

Rolls back uncommitted messages

Specified by:

rollback in interface SOMReceiver

Returns:

True on success.

tearDown

public void tearDown()

Tears down.

Specified by:

tearDown in interface SOMEndPoint

toString

public String toString()

Overrides:

toString in class Object