Package org.netxms.client
Class MessageHandler
- java.lang.Object
-
- org.netxms.client.MessageHandler
-
public abstract class MessageHandler extends Object
Message handler interface
-
-
Constructor Summary
Constructors Constructor Description MessageHandler()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected longgetLastMessageTimestamp()intgetMessageWaitTimeout()booleanisComplete()Get completion flagbooleanisTimeout()abstract booleanprocessMessage(org.netxms.base.NXCPMessage msg)Process message.protected voidsetComplete()Set handler to complete state.protected voidsetLastMessageTimestamp(long lastMessageTimestamp)voidsetMessageWaitTimeout(int messageWaitTimeout)protected voidsetTimeout()
-
-
-
Method Detail
-
setComplete
protected void setComplete()
Set handler to complete state. This will signal all waiters and remove subscription.
-
isComplete
public boolean isComplete()
Get completion flag- Returns:
- returns if message is complete
-
getLastMessageTimestamp
protected long getLastMessageTimestamp()
- Returns:
- the lastMessageTimestamp
-
setLastMessageTimestamp
protected void setLastMessageTimestamp(long lastMessageTimestamp)
- Parameters:
lastMessageTimestamp- the lastMessageTimestamp to set
-
isTimeout
public boolean isTimeout()
- Returns:
- the timeout
-
setTimeout
protected void setTimeout()
-
getMessageWaitTimeout
public int getMessageWaitTimeout()
- Returns:
- the messageWaitTimeout
-
setMessageWaitTimeout
public void setMessageWaitTimeout(int messageWaitTimeout)
- Parameters:
messageWaitTimeout- the messageWaitTimeout to set
-
processMessage
public abstract boolean processMessage(org.netxms.base.NXCPMessage msg)
Process message. If handler returns true message will not be placed into waiting queue.- Parameters:
msg- NXCP message to process- Returns:
- true if message is processed
-
-