|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.reporting.protocol.statserver.events.EventInfo
public abstract class EventInfo
Returns statistical information that does not concern routing targets. Issued in response to
RequestOpenStatistic
,
RequestOpenStatisticEx
,
RequestGetStatistic
,
RequestGetStatisticEx
, or
RequestPeekStatistic
.
Selected Properties:
Name | Description |
---|---|
ReferenceId | ReferenceId of the
RequestOpenStatistic ,
RequestOpenStatisticEx ,
RequestGetStatistic ,
RequestGetStatisticEx ,
RequestPeekStatistic
that was used to request the statistic. |
IntValue | Int value of the statistic. |
StringValue | String value of the statistic. |
Tag | User reference ID. |
Name | Description |
---|---|
RequestGetStatistic |
Requests one-time notification about a particular predefined statistic. |
RequestGetStatisticEx |
Requests one-time notification about a statistic that is defined in the request. |
RequestOpenStatistic |
Requests that Stat Server start sending information about a predefined statistics. |
RequestOpenStatisticEx |
Requests that Stat Server start sending information about a statistics that is defined in the request. |
RequestPeekStatistic |
Requests immediate recalculation and transmission of the value of a previously opened statistic. |
'EventInfo' ('2')
message attributes:
REQ_ID [int] = 2
USER_REQ_ID [int] = -1
TM_SERVER [int] = 1245879453
TM_LENGTH [int] = 52653
LONG_VALUE [int] = 0
STRING_VALUE [str] = "0"
Selected Property Naming Equivalents for Stat Server and Platform SDK:
Stat Server Name | Platform SDK Name |
---|---|
REQ_ID | ReferenceId |
LONG_VALUE | IntValue |
STRING_VALUE | StringValue |
USER_REQ_ID | Tag |
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static EventInfo |
create()
Creates instance of EventInfo with no parameters set. |
static EventInfo |
create(java.lang.Integer timestamp,
java.lang.Integer intervalLength,
java.lang.Integer intValue)
Creates instance of EventInfo with required parameters set. |
static EventInfo |
create(java.lang.Integer tag,
java.lang.Integer timestamp,
java.lang.Integer intervalLength,
java.lang.Integer intValue,
java.lang.String stringValue,
byte[] deltaValue,
IStatisticStatus stateValue)
Creates instance of EventInfo with all parameters set. |
abstract byte[] |
getDeltaValue()
|
abstract java.lang.Integer |
getIntervalLength()
Interval length for historical statistics. |
abstract java.lang.Integer |
getIntValue()
Specifies which type of profile information (statistical types, time profiles, time ranges, or filters) will be returned from a RequestGetStatisticProfile. |
abstract java.lang.Integer |
getReferenceId()
A unique integer that is specified for identification of requested statistics. |
abstract IStatisticStatus |
getStateValue()
|
abstract java.lang.String |
getStringValue()
|
abstract java.lang.Integer |
getTag()
User reference ID. |
abstract java.lang.Integer |
getTimestamp()
|
abstract void |
setDeltaValue(byte[] deltaValue)
|
abstract void |
setIntervalLength(int intervalLength)
Interval length for historical statistics. |
abstract void |
setIntervalLength(java.lang.Integer intervalLength)
Interval length for historical statistics. |
abstract void |
setIntValue(int intValue)
Specifies which type of profile information (statistical types, time profiles, time ranges, or filters) will be returned from a RequestGetStatisticProfile. |
abstract void |
setIntValue(java.lang.Integer intValue)
Specifies which type of profile information (statistical types, time profiles, time ranges, or filters) will be returned from a RequestGetStatisticProfile. |
abstract void |
setReferenceId(int referenceId)
A unique integer that is specified for identification of requested statistics. |
abstract void |
setReferenceId(java.lang.Integer referenceId)
A unique integer that is specified for identification of requested statistics. |
abstract void |
setStateValue(IStatisticStatus stateValue)
|
abstract void |
setStringValue(java.lang.String stringValue)
|
abstract void |
setTag(int tag)
User reference ID. |
abstract void |
setTag(java.lang.Integer tag)
User reference ID. |
abstract void |
setTimestamp(int timestamp)
|
abstract void |
setTimestamp(java.lang.Integer timestamp)
|
Methods inherited from class com.genesyslab.platform.commons.protocol.Message |
---|
cloneMessage, getEndpoint, getMessageAttribute, getProtocolDescription, getProtocolId, messageId, messageName, setProtocolDescription |
Methods inherited from class com.genesyslab.platform.commons.protocol.DataObject |
---|
equals, hashCode, toString, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static EventInfo create()
public static EventInfo create(java.lang.Integer tag, java.lang.Integer timestamp, java.lang.Integer intervalLength, java.lang.Integer intValue, java.lang.String stringValue, byte[] deltaValue, IStatisticStatus stateValue)
tag
- Tagtimestamp
- TimestampintervalLength
- IntervalLengthintValue
- IntValuestringValue
- StringValuedeltaValue
- DeltaValuestateValue
- StateValue
public static EventInfo create(java.lang.Integer timestamp, java.lang.Integer intervalLength, java.lang.Integer intValue)
timestamp
- TimestampintervalLength
- IntervalLengthintValue
- IntValue
public abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract java.lang.Integer getTag()
public abstract void setTag(java.lang.Integer tag)
public abstract void setTag(int tag)
public abstract java.lang.Integer getTimestamp()
public abstract void setTimestamp(java.lang.Integer timestamp)
public abstract void setTimestamp(int timestamp)
public abstract java.lang.Integer getIntervalLength()
public abstract void setIntervalLength(java.lang.Integer intervalLength)
public abstract void setIntervalLength(int intervalLength)
public abstract java.lang.Integer getIntValue()
public abstract void setIntValue(java.lang.Integer intValue)
public abstract void setIntValue(int intValue)
public abstract java.lang.String getStringValue()
public abstract void setStringValue(java.lang.String stringValue)
public abstract byte[] getDeltaValue()
public abstract void setDeltaValue(byte[] deltaValue)
public abstract IStatisticStatus getStateValue()
public abstract void setStateValue(IStatisticStatus stateValue)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |