|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jlab.coda.cMsg.cMsgMessage
org.jlab.coda.cMsg.cMsgMessageFull
public class cMsgMessageFull
This class contains the full functionality of a message. It extends the class that users have access to by defining setters and getters that the user has no need of. This class is for use only by packages that are part of the cMsg implementation. This whole class is really a private form of the cMsgMessage class.
Field Summary |
---|
Fields inherited from class org.jlab.coda.cMsg.cMsgMessage |
---|
allFields, expandedPayload, hasPayload, isBigEndian, isGetRequest, isGetResponse, isNullGetResponse, payloadFieldsOnly, systemFieldsOnly, wasSent |
Constructor Summary | |
---|---|
cMsgMessageFull()
Constructor. |
|
cMsgMessageFull(cMsgMessage m)
Constructor using existing cMsgMessage type of message. |
|
cMsgMessageFull(java.io.File file)
Constructor reading file generated by writing cMsgMessage.toString() output. |
|
cMsgMessageFull(java.lang.String XML)
Constructor using XML string generated by cMsgMessage.toString(). |
Method Summary | |
---|---|
java.lang.Object |
clone()
Clone this object. |
cMsgMessageFull |
copy()
Creates a complete copy of this message. |
boolean |
expandedPayload()
Does this message have a payload that consists of objects in a hashmap (ie. |
void |
expandedPayload(boolean ep)
Set the "expanded-payload" bit of a message. |
void |
expandPayload()
If this message is unexpanded (has a non-null payloadText field but no items in its payload hashmap), then expand the payload text into a hashmap containing all cMsgPayloadItems. |
int |
getReceiverSubscribeId()
Get receiverSubscribe id number. |
void |
makeNullResponse(cMsgMessageFull msg)
Converts existing message to null response of supplied message. |
void |
makeResponse(cMsgMessageFull msg)
Converts existing message to response of supplied message. |
cMsgMessageFull |
nullResponse()
Creates a proper response message to this message which was sent by a client calling sendAndGet. |
cMsgMessageFull |
response()
Creates a proper response message to this message which was sent by a client calling sendAndGet. |
void |
setContext(cMsgMessageContextInterface context)
Sets the object containing information about the context of the callback receiving this message. |
void |
setDomain(java.lang.String domain)
Set domain this message exists in. |
int |
setFieldsFromText(java.lang.String text,
int flag)
This method makes the protected method cMsgMessage.setFieldsFromText(java.lang.String, int) available
to other cMsg system classes. |
void |
setGetRequest(boolean getRequest)
Specify whether this message is a "sendAndGet" request. |
void |
setInfo(int info)
Set the info member. |
void |
setPayloadText(java.lang.String payloadText)
Sets the String representation of the compound payload of this message. |
void |
setReceiver(java.lang.String receiver)
Set message receiver. |
void |
setReceiverHost(java.lang.String receiverHost)
Set message receiver's host computer. |
void |
setReceiverSubscribeId(int receiverSubscribeId)
Set receiverSubscribe id number. |
void |
setReceiverTime(java.util.Date time)
Set time message was receivered. |
void |
setSender(java.lang.String sender)
Set message sender. |
void |
setSenderHost(java.lang.String senderHost)
Set message sender's host computer. |
void |
setSenderTime(java.util.Date time)
Set time message was sent. |
void |
setSenderToken(int senderToken)
Set sender's token. |
void |
setSysMsgId(int sysMsgId)
Set system id of message. |
void |
setVersion(int version)
Sets the version number of this message. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public cMsgMessageFull()
public cMsgMessageFull(java.lang.String XML) throws cMsgException
XML
- XML string
cMsgException
- if trouble parsing stringpublic cMsgMessageFull(java.io.File file) throws cMsgException
file
- file containing XML description of message
cMsgException
- if trouble reading file or parsing file contentspublic cMsgMessageFull(cMsgMessage m)
m
- regular message to create a full message fromMethod Detail |
---|
public java.lang.Object clone()
clone
in class cMsgMessage
public cMsgMessageFull copy()
copy
in class cMsgMessage
public cMsgMessageFull response() throws cMsgException
response
in class cMsgMessage
cMsgException
- if this message was not sent from a "sendAndGet" method callpublic cMsgMessageFull nullResponse() throws cMsgException
nullResponse
in class cMsgMessage
cMsgException
- if this message was not sent from a "sendAndGet" method callpublic void makeResponse(cMsgMessageFull msg)
msg
- message this message will be made a response topublic void makeNullResponse(cMsgMessageFull msg)
msg
- message this message will be made a null response topublic void setSysMsgId(int sysMsgId)
sysMsgId
- system id of message.public void setDomain(java.lang.String domain)
domain
- domain this message exists in.public void setGetRequest(boolean getRequest)
getRequest
- true if this message is a "sendAndGet" requestpublic void setInfo(int info)
info
- value of info memberpublic void setVersion(int version)
cMsgConstants.version
.
version
- version number of messagepublic void setSender(java.lang.String sender)
sender
- message sender.public void setSenderHost(java.lang.String senderHost)
senderHost
- message sender's host computer.public void setSenderTime(java.util.Date time)
time
- time message sent.public void setSenderToken(int senderToken)
senderToken
- sender's token.public void setReceiver(java.lang.String receiver)
receiver
- message receiver.public void setReceiverHost(java.lang.String receiverHost)
receiverHost
- message receiver's host computer.public void setReceiverTime(java.util.Date time)
time
- time message received.public int getReceiverSubscribeId()
getReceiverSubscribeId
in class cMsgMessage
public void setReceiverSubscribeId(int receiverSubscribeId)
receiverSubscribeId
- id numberpublic void setContext(cMsgMessageContextInterface context)
context
- object containing information about the context of the
callback receiving this messagepublic void setPayloadText(java.lang.String payloadText)
payloadText
- payloadText of this message.public boolean expandedPayload()
public void expandedPayload(boolean ep)
ep
- boolean which is true if msg has an expanded payload, else falsepublic void expandPayload()
public int setFieldsFromText(java.lang.String text, int flag) throws cMsgException
cMsgMessage.setFieldsFromText(java.lang.String, int)
available
to other cMsg system classes.
setFieldsFromText
in class cMsgMessage
text
- string sent over network to be unmarshalledflag
- if cMsgMessage.systemFieldsOnly
, set system msg fields only,
if cMsgMessage.payloadFieldsOnly
set payload msg fields only,
and if cMsgMessage.allFields
set both
cMsgException
- if the text is in a bad format or the text arg is null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |