Package org.serviceconnector.util

Class SynchronousCallback

java.lang.Object

org.serviceconnector.util.SynchronousCallback

All Implemented Interfaces:

ISCMPMessageCallback, ISCMPSynchronousCallback

Direct Known Subclasses:

CommandCallback, SCServiceCallback, SCSessionServer.SCServerCallback

public abstract class SynchronousCallback
extends Object
implements ISCMPSynchronousCallback

The Class SynchronousCallback. Base functionality for getting messages synchronous. Means to wait for a call for the callback. This class is designed to be extended by various callback's. It provides synchronous flag to to save state if somebody is waiting for a message. Synchronous flag might be useful in subclasses. It only gets access to the newest message - it only queues one item. Queuing an arrived message happens only if someone is expecting (synchronous = true) a reply. This restriction prevents race conditions - late messages are ignored.

Author:

JTraber

Field Summary

Fields

Modifier and Type	Field	Description
protected final BlockingQueue<SCMPMessage>	answer	Queue to store the answer.
protected boolean	synchronous	The synchronous, marks if somebody waits for the message.

Constructor Summary

Constructors

Constructor	Description
SynchronousCallback()	Instantiates a new synchronous callback.

Method Summary

Modifier and Type	Method	Description
SCMPMessage	getMessageSync(int timeoutMillis)	Careful, be aware of timeout concept if you use this method.
void	receive(Exception ex)	Callback.
void	receive(SCMPMessage scmpReply)	Callback.

Methods inherited from class java.lang.Object

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

Field Details

answer

protected final BlockingQueue<SCMPMessage> answer

Queue to store the answer.

synchronous

protected volatile boolean synchronous

The synchronous, marks if somebody waits for the message.

Constructor Details

SynchronousCallback

public SynchronousCallback()

Instantiates a new synchronous callback.

Method Details

receive

public void receive(SCMPMessage scmpReply)

Callback. This method gets informed when a message received.

Specified by:

receive in interface ISCMPMessageCallback

Specified by:

receive in interface ISCMPSynchronousCallback

Parameters:

scmpReply - the scmp reply

receive

public void receive(Exception ex)

Callback. This method gets informed in case of an error.

Specified by:

receive in interface ISCMPMessageCallback

Specified by:

receive in interface ISCMPSynchronousCallback

Parameters:

ex - the ex

getMessageSync

public SCMPMessage getMessageSync(int timeoutMillis)

Careful, be aware of timeout concept if you use this method. Gets the message synchronous. Waits until message/fault received or time you hand over runs out.

Specified by:

getMessageSync in interface ISCMPSynchronousCallback

Parameters:

timeoutMillis - the timeout in milliseconds

Returns:

the message sync