com.goldencode.p2j.net

Class WaitingThread

java.lang.Object

com.goldencode.p2j.net.WaitingThread

class WaitingThread
extends java.lang.Object

This class represents an container which is placed into Pool of Waiting Threads (PWT). It also used as an object instance on which thread is put into waiting state.

Version:

1.0

Author:

SIY

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Exception	exception A reference to an exception which indicates a failure.
private Message	message A reference to the reply message.

Constructor Summary

Constructors

Constructor and Description
WaitingThread() Constructs an empty instance.

Method Summary

Modifier and Type	Method and Description
(package private) void	notifyException(java.lang.Exception exception) Notify waiting thread that a failure occurred.
(package private) void	notifyMessage(Message message) Notify waiting thread that the reply message that matched the request message's ID has arrived.
(package private) Message	waitMessage(int timeout) Suspend calling thread and wait until a matching reply message is received, an exception is thrown, an interruption occurs or there is a timeout.

Methods inherited from class java.lang.Object

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

Field Detail

exception

private java.lang.Exception exception

A reference to an exception which indicates a failure.

message

private Message message

A reference to the reply message.

Constructor Detail

WaitingThread

WaitingThread()

Constructs an empty instance.

Method Detail

notifyException

void notifyException(java.lang.Exception exception)

Notify waiting thread that a failure occurred.

Parameters:

exception - An exception to deliver. If it is null then thread is awakened but an exception will not be thrown.

notifyMessage

void notifyMessage(Message message)

Notify waiting thread that the reply message that matched the request message's ID has arrived.

Parameters:

message - The reply message that was received.

waitMessage

Message waitMessage(int timeout)
             throws java.lang.InterruptedException,
                    java.lang.Exception

Suspend calling thread and wait until a matching reply message is received, an exception is thrown, an interruption occurs or there is a timeout. If the timeout parameter is not 0 then the waiting time is limited to at least that specified amount of time. If time is 0 then the thread waits indefinitely (or until the application or the user's session ends). A reply matches if the request ID is the same as the given request ID.

Parameters:

timeout - Time to wait for reply message (milliseconds).

Returns:

The reply message or null if no reply is received.

Throws:

java.lang.InterruptedException - Forwarded from Object.wait().

java.lang.Exception - Any other failure.