com.prosysopc.ua.stack.utils

Interface IStatefulObject<T,E extends Throwable>

All Known Subinterfaces:

CloseableObject, EndpointServer

All Known Implementing Classes:

AbstractServerConnection, AbstractServerSecureChannel, AbstractState, AsyncRead, AsyncServerSocket, AsyncSocketImpl, AsyncWrite, BufferMonitor, HttpsServer, HttpsServerConnection, HttpsServerSecureChannel, OpcTcpServer, OpcTcpServerConnection, OpcTcpServerSecureChannel, State

public interface IStatefulObject<T,E extends Throwable>

IStatefulObject interface.

Method Summary

Modifier and Type	Method and Description
void	addStateListener(StateListener<T> listener) Add on-event listener.
void	addStateNotifiable(StateListener<T> notifiable) Add post-event notification listener.
E	getError() Get error state or null.
T	getState() getState.
void	removeStateListener(StateListener<T> listener) removeStateListener.
void	removeStateNotifiable(StateListener<T> notifiable) removeStateNotifiable.
T	waitForState(Set<T> set) Wait until state changes to one of the given states.
T	waitForState(Set<T> set, long timeout, TimeUnit unit) Wait until state changes to one of the given states or until time out occurs.
T	waitForStateUninterruptibly(Set<T> set) Wait until state changes to one of the given states.

Method Detail

addStateListener

void addStateListener(StateListener<T> listener)

Add on-event listener.

Parameters:

listener - a StateListener object.

addStateNotifiable

void addStateNotifiable(StateListener<T> notifiable)

Add post-event notification listener. The prosessing thread is random. The prosessing order is not guaranteed if the handling is not synchronized.

Parameters:

notifiable - a StateListener object.

getError

E getError()

Get error state or null.

Returns:

error

getState

T getState()

getState.

Returns:

a StateType object.

removeStateListener

void removeStateListener(StateListener<T> listener)

removeStateListener.

Parameters:

listener - a StateListener object.

removeStateNotifiable

void removeStateNotifiable(StateListener<T> notifiable)

removeStateNotifiable.

Parameters:

notifiable - a StateListener object.

waitForState

T waitForState(Set<T> set)
        throws InterruptedException,
               E extends Throwable

Wait until state changes to one of the given states.

Parameters:

set - states that ends waiting

Returns:

the state in the given set that broke the wait

Throws:

InterruptedException - if any.

E - if any.

E extends Throwable

waitForState

T waitForState(Set<T> set,
               long timeout,
               TimeUnit unit)
        throws InterruptedException,
               TimeoutException,
               E extends Throwable

Wait until state changes to one of the given states or until time out occurs.

Parameters:

set - a Set object.

timeout - a long.

unit - a TimeUnit object.

Returns:

state one in set

Throws:

InterruptedException - thread was interrupted

TimeoutException - timeout occured

E - if any.

E extends Throwable

waitForStateUninterruptibly

T waitForStateUninterruptibly(Set<T> set)
                       throws E extends Throwable

Wait until state changes to one of the given states.

Parameters:

set - states that ends waiting

Returns:

the state in the given set that broke the wait

Throws:

E - if any.

E extends Throwable