org.rvpf.base.som

Class TopicProxy.Subscriber

Object

SessionProxy

SOMProxy

TopicProxy

TopicProxy.Subscriber

All Implemented Interfaces:

Remote, Session, SOMSession, SubscriberSession

Enclosing class:

TopicProxy

public static final class TopicProxy.Subscriber
extends TopicProxy
implements SubscriberSession

Subscriber.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TopicProxy.Subscriber.Builder Builder.

Nested classes/interfaces inherited from class TopicProxy

TopicProxy.Publisher, TopicProxy.Subscriber

Nested classes/interfaces inherited from class SOMProxy

SOMProxy.ContextProperties

Nested classes/interfaces inherited from class SessionProxy

SessionProxy.Listener, SessionProxy.SessionConnectVetoException

Nested classes/interfaces inherited from interface Session

Session.ConnectionMode

Field Summary

Fields inherited from class SOMProxy

PASSWORD_PROPERTY, TIMEOUT_PROPERTY, USER_PROPERTY

Method Summary

Modifier and Type	Method and Description
protected Session	createSession() Creates a session.
static TopicProxy.Subscriber.Builder	newBuilder() Returns a new builder.
Serializable[]	receive(int limit, long timeout) Receives messages.
protected String	sessionMode() Returns some session mode identifying text.

Methods inherited from class TopicProxy

getInfo

Methods inherited from class SOMProxy

close, confirmTimeout, connect, disconnect, getSOMName, isClosed

Methods inherited from class SessionProxy

getClientName, getConnectionMode, getContext, getContextUUID, getFactory, getServerName, getServerURI, getSession, getThisLogger, hasLoginInfo, isConnected, isPrivate, isRemote, lockConnect, lockConnectInterruptibly, login, logout, sessionException, tearDown, unlockConnect

Methods inherited from class Object

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

Methods inherited from interface SOMSession

close

Methods inherited from interface Session

getConnectionMode, login, logout

Method Detail

newBuilder

@Nonnull
 @CheckReturnValue
public static TopicProxy.Subscriber.Builder newBuilder()

Returns a new builder.

Returns:

The new builder.

receive

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

Receives messages.

Specified by:

receive in interface SubscriberSession

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.

Throws:

SessionException - From session security check.

createSession

protected Session createSession()
                         throws RemoteException,
                                SessionException

Creates a session.

Overrides:

createSession in class TopicProxy

Returns:

The session.

Throws:

RemoteException - From RMI.

SessionException - When session creation fails.

sessionMode

protected String sessionMode()

Returns some session mode identifying text.

Overrides:

sessionMode in class SessionProxy

Returns:

The session mode identifying text.