Interface DSStatus
-
- All Superinterfaces:
DSPacket
,DSSerializable
public interface DSStatus extends DSPacket
Sends a user-defined status message about a particular object. The S_INFO, S_STALE, S_REMOVE and S_NOTSTALE flags are mutually exclusive.
-
-
Field Summary
Fields Modifier and Type Field Description static int
S_INFO
This is an information only status message.static int
S_NOTMAPPED
This indicates that the subject should be discarded.static int
S_NOTSTALE
This indicates that an object is no longer stale and is receiving updates.static int
S_REMOVE
This indicates there is a serious problem with object and it should be removed from the client watchlists.static int
S_STALE
This indicates that the object may not be receiving updates any more.static int
S_UPDCLR
This indicates an update to this object should clear the previously sent S_STALE or S_NOTSTALE message.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getCode()
Gets the code for this status message.int
getFlags()
Gets the flags for this status message.java.lang.String
getMessage()
Gets the message for this status message.java.lang.String
getSubject()
Gets this object's subject.-
Methods inherited from interface com.caplin.datasource.interfaces.DSPacket
send, sendDirect, sendToPeer
-
Methods inherited from interface com.caplin.datasource.interfaces.DSSerializable
toBytes
-
-
-
-
Field Detail
-
S_INFO
static final int S_INFO
This is an information only status message.- See Also:
- Constant Field Values
-
S_STALE
static final int S_STALE
This indicates that the object may not be receiving updates any more.
- See Also:
- Constant Field Values
-
S_REMOVE
static final int S_REMOVE
This indicates there is a serious problem with object and it should be removed from the client watchlists.
- See Also:
- Constant Field Values
-
S_NOTSTALE
static final int S_NOTSTALE
This indicates that an object is no longer stale and is receiving updates.
- See Also:
- Constant Field Values
-
S_NOTMAPPED
static final int S_NOTMAPPED
This indicates that the subject should be discarded.
- See Also:
- Constant Field Values
-
S_UPDCLR
static final int S_UPDCLR
This indicates an update to this object should clear the previously sent S_STALE or S_NOTSTALE message. The S_UPDCLR flag should be sent at the same time as the S_STALE or S_NOTSTALE message.
- See Also:
- Constant Field Values
-
-
Method Detail
-
getSubject
java.lang.String getSubject()
Gets this object's subject.
- Returns:
- The subject name.
-
getFlags
int getFlags()
Gets the flags for this status message.
- Returns:
- The flags of this status message.
-
getCode
int getCode()
Gets the code for this status message.
- Returns:
- the code.
-
getMessage
java.lang.String getMessage()
Gets the message for this status message.
- Returns:
- the message.
-
-