org.jlab.coda.cMsg.common

Class cMsgGetHelper

java.lang.Object

org.jlab.coda.cMsg.common.cMsgGetHelper

Direct Known Subclasses:

cMsgSubscription

public class cMsgGetHelper
extends java.lang.Object

This class is used to help in implementing some sendAndGet, subscribeAndGet, and syncSend methods. This is true in the cMsg domain for the client and in the RCMulticast and RCServer domains for servers. An object of this class stores a msg from a sender to the method's caller and is used to synchronize/wait/notify on. It also indicates whether the call timed out or not.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	errorCode When a "subscribeAndGet" or "sendAndGet" is woken up by an error condition, such as "the server died", this code is set.
(package private) int	intVal Used to store syncSend return value.
(package private) cMsgMessageFull	message Message object.
(package private) java.util.concurrent.atomic.AtomicBoolean	timedOut Has the "subscribeAndGet" or "sendAndGet" call timed out?

Constructor Summary

Constructors

Constructor and Description
cMsgGetHelper()

Method Summary

Modifier and Type	Method and Description
int	getErrorCode() Gets the error code from when a "subscribeAndGet" or "sendAndGet" is woken up by an error condition.
int	getIntVal() Gets intVal from when a "syncSend" is woken up.
cMsgMessageFull	getMessage() Returns the message object.
boolean	isTimedOut() Returns true if the "subscribeAndGet" or "sendAndGet" call timed out.
boolean	needToWait() Returns true if the "syncSend" response has not yet been received and the client still needs to wait for it.
void	setErrorCode(int errorCode) Sets the error code from when a "subscribeAndGet" or "sendAndGet" is woken up by an error condition.
void	setIntVal(int intVal) Sets intVal from when a "syncSend" is woken up.
void	setMessage(cMsgMessageFull message) Sets the messge object;
void	setTimedOut(boolean timedOut) Set boolean telling whether he "subscribeAndGet" or "sendAndGet" call timed out or not.

Methods inherited from class java.lang.Object

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

Field Detail

message

cMsgMessageFull message

Message object.

timedOut

java.util.concurrent.atomic.AtomicBoolean timedOut

Has the "subscribeAndGet" or "sendAndGet" call timed out?

errorCode

int errorCode

When a "subscribeAndGet" or "sendAndGet" is woken up by an error condition, such as "the server died", this code is set.

intVal

int intVal

Used to store syncSend return value.

Constructor Detail

cMsgGetHelper

public cMsgGetHelper()

Method Detail

getMessage

public cMsgMessageFull getMessage()

Returns the message object.

Returns:

the message object.

setMessage

public void setMessage(cMsgMessageFull message)

Sets the messge object;

Parameters:

message - the message object

needToWait

public boolean needToWait()

Returns true if the "syncSend" response has not yet been received and the client still needs to wait for it.

Returns:

true if the "syncSend" response has not yet been received and the client still needs to wait for it

isTimedOut

public boolean isTimedOut()

Returns true if the "subscribeAndGet" or "sendAndGet" call timed out.

Returns:

true if the "subscribeAndGet" or "sendAndGet" call timed out.

setTimedOut

public void setTimedOut(boolean timedOut)

Set boolean telling whether he "subscribeAndGet" or "sendAndGet" call timed out or not.

Parameters:

timedOut - boolean telling whether he "subscribeAndGet" or "sendAndGet" call timed out or not.

getErrorCode

public int getErrorCode()

Gets the error code from when a "subscribeAndGet" or "sendAndGet" is woken up by an error condition.

Returns:

error code

setErrorCode

public void setErrorCode(int errorCode)

Sets the error code from when a "subscribeAndGet" or "sendAndGet" is woken up by an error condition.

Parameters:

errorCode - error code

getIntVal

public int getIntVal()

Gets intVal from when a "syncSend" is woken up.

Returns:

syncSend intVal

setIntVal

public void setIntVal(int intVal)

Sets intVal from when a "syncSend" is woken up.

Parameters:

intVal - syncSend response