|
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.management.protocol.messageserver.events.EventError
public abstract class EventError
Indicates that exception occurred on message server socket
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static EventError |
create()
Creates instance of EventError with no parameters set. |
static EventError |
create(MessageTypes messageType,
java.util.Date time,
java.lang.Integer subscriberType)
Creates instance of EventError with required parameters set. |
static EventError |
create(MessageTypes messageType,
java.util.Date time,
java.lang.Integer subscriberType,
java.lang.Integer attachedDataLength,
byte[] attachedData,
KeyValueCollection userData)
Creates instance of EventError with all parameters set. |
abstract byte[] |
getAttachedData()
Any data attached to the message |
abstract java.lang.Integer |
getAttachedDataLength()
Length of the attached data |
abstract MessageTypes |
getMessageType()
The message type. |
abstract java.lang.Integer |
getSubscriberType()
Subscription: Type of the message to subscribe to |
abstract java.util.Date |
getTime()
Note that server sends this value in UTC format always. |
abstract KeyValueCollection |
getUserData()
Attached data packed in TKVList |
abstract void |
setAttachedData(byte[] attachedData)
Any data attached to the message |
abstract void |
setAttachedDataLength(int attachedDataLength)
Length of the attached data |
abstract void |
setAttachedDataLength(java.lang.Integer attachedDataLength)
Length of the attached data |
abstract void |
setMessageType(MessageTypes messageType)
The message type. |
abstract void |
setSubscriberType(int subscriberType)
Subscription: Type of the message to subscribe to |
abstract void |
setSubscriberType(java.lang.Integer subscriberType)
Subscription: Type of the message to subscribe to |
abstract void |
setTime(java.util.Date time)
Note that server sends this value in UTC format always. |
abstract void |
setUserData(KeyValueCollection userData)
Attached data packed in TKVList |
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 EventError create()
public static EventError create(MessageTypes messageType, java.util.Date time, java.lang.Integer subscriberType, java.lang.Integer attachedDataLength, byte[] attachedData, KeyValueCollection userData)
messageType
- Type of the messagetime
- Note that server sends this value in UTC format always.subscriberType
- Subscription: Type of the message to subscribe toattachedDataLength
- Length of the attached dataattachedData
- Any data attached to the messageuserData
- Attached data packed in TKVList
public static EventError create(MessageTypes messageType, java.util.Date time, java.lang.Integer subscriberType)
messageType
- Type of the messagetime
- Note that server sends this value in UTC format always.subscriberType
- Subscription: Type of the message to subscribe to
public abstract MessageTypes getMessageType()
public abstract void setMessageType(MessageTypes messageType)
public abstract java.util.Date getTime()
public abstract void setTime(java.util.Date time)
time
- new value of the propertypublic abstract java.lang.Integer getSubscriberType()
public abstract void setSubscriberType(java.lang.Integer subscriberType)
subscriberType
- new value of the propertypublic abstract void setSubscriberType(int subscriberType)
subscriberType
- new value of the propertypublic abstract java.lang.Integer getAttachedDataLength()
public abstract void setAttachedDataLength(java.lang.Integer attachedDataLength)
attachedDataLength
- new value of the propertypublic abstract void setAttachedDataLength(int attachedDataLength)
attachedDataLength
- new value of the propertypublic abstract byte[] getAttachedData()
public abstract void setAttachedData(byte[] attachedData)
attachedData
- new value of the propertypublic abstract KeyValueCollection getUserData()
public abstract void setUserData(KeyValueCollection userData)
userData
- new value of the property
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |