Serialized Form

Package org.jlab.coda.cMsg

Class org.jlab.coda.cMsg.cMsgException extends java.lang.Exception implements Serializable

Serialized Fields

returnCode

int returnCode

Class org.jlab.coda.cMsg.cMsgMessage extends java.lang.Object implements Serializable

Serialized Fields

byteArrayCopied

boolean byteArrayCopied

Was the byte array copied in or only a reference assigned?

historyLengthMax

int historyLengthMax

Maximum number of entries a message keeps when recording the history of various parameters.

sysMsgId

int sysMsgId

Unique message intVal created by cMsg system. Used by cMsg domain server to track client's "sendAndGet" calls.

domain

java.lang.String domain

Message exists in this domain.

info

int info

Condensed information stored in bits. Is message a sendAndGet request? -- stored in 1st bit. Is message a response to a sendAndGet? -- stored in 2nd bit. Is the response message null instead of a message? -- stored in 3rd bit. Is the byte array data in big endian form? -- stored in 4th bit. Was it sent over the wire? -- stored in 5th bit. Does it have a compound payload? -- stored in 6th bit. Is the payload expanded? -- stored in 7th bit. Does local server have no subscriber for send of sendAndGet? -- stored in 8th bit.

See Also:

cMsgMessage.isGetRequest, cMsgMessage.isGetResponse, cMsgMessage.isNullGetResponse, cMsgMessage.isBigEndian, cMsgMessage.wasSent, cMsgMessage.hasPayload(), cMsgMessage.isExpandedPayload(), cMsgMessage.isNullGetServerResponse()

version

int version

Version number of cMsg.

reserved

int reserved

Class member reserved for future use.

subject

java.lang.String subject

Subject of message.

type

java.lang.String type

Type of message.

text

java.lang.String text

Text of message.

userInt

int userInt

Integer supplied by user.

userTime

long userTime

Time supplied by user in milliseconds from midnight GMT, Jan 1st, 1970.

bytes

byte[] bytes

Byte array of message.

offset

int offset

Offset into byte array of first element.

length

int length

Length of byte array elements to use.

payloadText

java.lang.String payloadText

String representation of the entire payload (including hidden system payload items).

sender

java.lang.String sender

Name of message sender (must be unique in some domains).

senderHost

java.lang.String senderHost

Host sender is running on.

senderTime

long senderTime

Time message was sent in milliseconds from midnight GMT, Jan 1st, 1970.

senderToken

int senderToken

Field used by domain server in implementing "sendAndGet".

receiver

java.lang.String receiver

Name of message receiver.

receiverHost

java.lang.String receiverHost

Host receiver is running on.

receiverTime

long receiverTime

Time message was received in milliseconds from midnight GMT, Jan 1st, 1970.

reliableSend

boolean reliableSend

Should the message be sent with a reliable method (TCP) or is an unreliable method (UDP) ok?

Class org.jlab.coda.cMsg.cMsgPayloadItem extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

Name of this item.

text

java.lang.String text

String representation for this item, containing name, type, count, length, values, etc for wire protocol.

type

int type

Type of item (number, bin, string, msg, ...) stored here. The type may have the following values:

• cMsgConstants.payloadStr for a String
• cMsgConstants.payloadFlt for a 4 byte float
• cMsgConstants.payloadDbl for an 8 byte float
• cMsgConstants.payloadInt8 for an 8 bit int
• cMsgConstants.payloadInt16 for a 16 bit int
• cMsgConstants.payloadInt32 for a 32 bit int
• cMsgConstants.payloadInt64 for a 64 bit int
• cMsgConstants.payloadUint8 for an unsigned 8 bit int
• cMsgConstants.payloadUint16 for an unsigned 16 bit int
• cMsgConstants.payloadUint32 for an unsigned 32 bit int
• cMsgConstants.payloadUint64 for an unsigned 64 bit int
• cMsgConstants.payloadMsg for a cMsg message
• cMsgConstants.payloadBin for binary
  
• cMsgConstants.payloadStrA for a String array
• cMsgConstants.payloadFltA for a 4 byte float array
• cMsgConstants.payloadDblA for an 8 byte float array
• cMsgConstants.payloadInt8A for an 8 bit int array
• cMsgConstants.payloadInt16A for a 16 bit int array
• cMsgConstants.payloadInt32A for a 32 bit int array
• cMsgConstants.payloadInt64A for a 64 bit int array
• cMsgConstants.payloadUint8A for an unsigned 8 bit int array
• cMsgConstants.payloadUint16A for an unsigned 16 bit int array
• cMsgConstants.payloadUint32A for an unsigned 32 bit int array
• cMsgConstants.payloadUint64A for an unsigned 64 bit int array
• cMsgConstants.payloadMsgA for a cMsg message array
• cMsgConstants.payloadBinA for an array of binary items

originalType

int originalType

If type was originally unsigned and then promoted in Java, this stores that unsigned type.

originalText

java.lang.String originalText

If type was originally unsigned and then promoted in Java, this stores the original string representation for this item.

count

int count

Number of items in array if array, else 1.

noHeaderLen

int noHeaderLen

Length of text in chars without header (first) line.

endian

int endian

Endian value if item is binary.

endianArray

int[] endianArray

Endian values if item is array of binary arrays.

isSystem

boolean isSystem

Is this item part of a hidden system field in the payload?

item

java.lang.Object item

Place to store the item passed to the constructor.