org.jlab.coda.cMsg
Class cMsgConstants

java.lang.Object
  extended by org.jlab.coda.cMsg.cMsgConstants

public class cMsgConstants
extends java.lang.Object

This interface defines some useful constants. These constants correspond to identical constants defined in the C implementation of cMsg.

Version:
1.0
Author:
Carl Timmer

Field Summary
static int debugError
          Print out severe and normal error messages.
static int debugInfo
          Print out all error, warning, and informational messages.
static int debugNone
          Print out no status messages.
static int debugSevere
          Print out only severe error messages.
static int debugWarn
          Print out all error and warning messages.
static int endianBig
          Data is big endian.
static int endianLittle
          Data is little endian.
static int endianLocal
          Data's endian is the same as the local host's.
static int endianNotLocal
          Data's endian is opposite of the local host's.
static int endianSwitch
          Switch recorded value of data's endianness.
static int error
          General error.
static int errorAbort
          Error due to aborted procedure.
static int errorAlreadyExists
          Specifying that a unique item already exists.
static int errorAlreadyInitialized
          Error since already initialized.
static int errorBadArgument
          Specifying a bad argument.
static int errorBadDomainId
          Error due to not matching any existing domain.
static int errorBadDomainType
          Specifying a domain type that does not exist or is not supported.
static int errorBadFormat
          Specifying a bad format.
static int errorBadMessage
          Error due to message not being in the correct form.
static int errorDifferentVersion
          Error due to being different version.
static int errorIllegalMessageType
          Specifying illegal message type.
static int errorLimitExceeded
          Error due to a limit that was exceeded.
static int errorLostConnection
          Error since lost network connection.
static int errorNetwork
          Error due to network communication problem.
static int errorNoClassFound
          Error due to no Java class found for specified subdomain.
static int errorNoMemory
          Error due to no more computer memory.
static int errorNotImplemented
          Specifying a feature not implemented.
static int errorNotInitialized
          Error since not initialized.
static int errorOutOfRange
          Specifying out-of-range parameter.
static int errorPend
          Error waiting for messages to arrive.
static int errorServerDied
          Error due to server dying.
static int errorSocket
          Error due to bad socket specification.
static int errorTimeout
          Error specifying a time out.
static int errorWrongDomainType
          Specifying a different domain type than expected.
static int errorWrongPassword
          Error due to wrong password.
static int includeMe
          For shutdownClients, do NOT exclude the client calling shutdown from being shutdown.
static int includeMyServer
          For shutdownServers, do NOT exclude the server that the calling client is connected to from being shutdown.
static int minorVersion
          Minor cMsg version number.
static int msgConnectRequest
          Connect to the server from client.
static int msgDisconnectRequest
          Disconnect client from the server.
static int msgGetResponse
          Respond to a "sendAndGet" request.
static int msgKeepAlive
          See if the process on the other end of the socket is still alive.
static int msgMonitorRequest
          Send "monitor" request.
static int msgRcAbortConnect
          Respond to a runcontrol server's "connect" request.
static int msgRcConnect
          Respond to a runcontrol server's "connect" request.
static int msgSendAndGetRequest
          Get a message from a responder of a sent message.
static int msgSendRequest
          Send a message.
static int msgServerCloudLock
          Lock server from joining server cloud or accepting registrations.
static int msgServerCloudSetStatus
          Unlock server for joining server cloud or accepting registrations.
static int msgServerCloudUnlock
          Unlock server for joining server cloud or accepting registrations.
static int msgServerConnectRequest
          Connect to the server from server.
static int msgServerDisconnectRequest
          Disconnect server from the server.
static int msgServerGetResponse
          Respond to a server's "sendAndGet" request.
static int msgServerRegisterClient
          Register client from another server.
static int msgServerRegistrationLock
          Lock server from doing other registrations.
static int msgServerRegistrationUnlock
          Unlock server for doing other registrations.
static int msgServerSendAndGetRequest
          SendAndGet a message by another server.
static int msgServerSendClientNames
          Send names of local clients.
static int msgServerShutdownClients
          Shutdown various clients.
static int msgServerShutdownSelf
          Shutdown various servers.
static int msgServerSubscribeAndGetRequest
          SubscribeAndGet a message by another server.
static int msgServerSubscribeRequest
          Subscribe to messages by another server.
static int msgServerUnRegisterClient
          Unregister client from another server.
static int msgServerUnSendAndGetRequest
          UnSendAndGet to a message by another server.
static int msgServerUnsubscribeAndGetRequest
          UnsubscribeAndGet to a message by another server.
static int msgServerUnsubscribeRequest
          Unsubscribe to messages by another server.
static int msgShutdownClients
          Shutdown various clients.
static int msgShutdownServers
          Shutdown various servers.
static int msgSubscribeAndGetRequest
          Get a message with 1-shot subscribe.
static int msgSubscribeRequest
          Subscribe to messages.
static int msgSubscribeResponse
          Respond with message to the subscribe command.
static int msgSyncSendRequest
          Send a message with synchronous response.
static int msgUnSendAndGetRequest
          Remove "sendAndGet" request.
static int msgUnsubscribeAndGetRequest
          Remove "subscribeAndGet" request.
static int msgUnsubscribeRequest
          Unsubscribe to messages.
static int ok
          No error.
static int payloadBin
          Binary array in cMsg message payload.
static int payloadDbl
          8 byte double item in cMsg message payload.
static int payloadDblA
          8 byte double array item in cMsg message payload.
static int payloadFlt
          4-byte float item in cMsg message payload.
static int payloadFltA
          4-byte float array item in cMsg message payload.
static int payloadInt16
          2 byte signed integer item in cMsg message payload.
static int payloadInt16A
          2 byte signed integer array item in cMsg message payload.
static int payloadInt32
          4 byte signed integer item in cMsg message payload.
static int payloadInt32A
          4 byte signed integer array item in cMsg message payload.
static int payloadInt64
          8 byte signed integer item in cMsg message payload.
static int payloadInt64A
          8 byte signed integer array item in cMsg message payload.
static int payloadInt8
          1 byte signed integer item in cMsg message payload.
static int payloadInt8A
          1 byte signed integer array item in cMsg message payload.
static int payloadMsg
          cMsg message in cMsg message payload.
static int payloadMsgA
          cMsg message array in cMsg message payload.
static int payloadStr
          String item in cMsg message payload.
static int payloadStrA
          String array item in cMsg message payload.
static int payloadUint16
          2 byte unsigned integer item in cMsg message payload.
static int payloadUint16A
          2 byte unsigned integer array item in cMsg message payload.
static int payloadUint32
          4 byte unsigned integer item in cMsg message payload.
static int payloadUint32A
          4 byte unsigned integer array item in cMsg message payload.
static int payloadUint64
          8 byte unsigned integer item in cMsg message payload.
static int payloadUint64A
          8 byte unsigned integer array item in cMsg message payload.
static int payloadUint8
          1 byte unsigned integer item in cMsg message payload.
static int payloadUint8A
          1 byte unsigned integer array item in cMsg message payload.
static int version
          Major cMsg version number.
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

version

public static final int version
Major cMsg version number.

See Also:
Constant Field Values

minorVersion

public static final int minorVersion
Minor cMsg version number.

See Also:
Constant Field Values

debugNone

public static final int debugNone
Print out no status messages.

See Also:
Constant Field Values

debugSevere

public static final int debugSevere
Print out only severe error messages.

See Also:
Constant Field Values

debugError

public static final int debugError
Print out severe and normal error messages.

See Also:
Constant Field Values

debugWarn

public static final int debugWarn
Print out all error and warning messages.

See Also:
Constant Field Values

debugInfo

public static final int debugInfo
Print out all error, warning, and informational messages.

See Also:
Constant Field Values

endianBig

public static final int endianBig
Data is big endian.

See Also:
Constant Field Values

endianLittle

public static final int endianLittle
Data is little endian.

See Also:
Constant Field Values

endianLocal

public static final int endianLocal
Data's endian is the same as the local host's.

See Also:
Constant Field Values

endianNotLocal

public static final int endianNotLocal
Data's endian is opposite of the local host's.

See Also:
Constant Field Values

endianSwitch

public static final int endianSwitch
Switch recorded value of data's endianness.

See Also:
Constant Field Values

ok

public static final int ok
No error.

See Also:
Constant Field Values

error

public static final int error
General error.

See Also:
Constant Field Values

errorTimeout

public static final int errorTimeout
Error specifying a time out.

See Also:
Constant Field Values

errorNotImplemented

public static final int errorNotImplemented
Specifying a feature not implemented.

See Also:
Constant Field Values

errorBadArgument

public static final int errorBadArgument
Specifying a bad argument.

See Also:
Constant Field Values

errorBadFormat

public static final int errorBadFormat
Specifying a bad format.

See Also:
Constant Field Values

errorBadDomainType

public static final int errorBadDomainType
Specifying a domain type that does not exist or is not supported.

See Also:
Constant Field Values

errorAlreadyExists

public static final int errorAlreadyExists
Specifying that a unique item already exists.

See Also:
Constant Field Values

errorNotInitialized

public static final int errorNotInitialized
Error since not initialized.

See Also:
Constant Field Values

errorAlreadyInitialized

public static final int errorAlreadyInitialized
Error since already initialized.

See Also:
Constant Field Values

errorLostConnection

public static final int errorLostConnection
Error since lost network connection.

See Also:
Constant Field Values

errorNetwork

public static final int errorNetwork
Error due to network communication problem.

See Also:
Constant Field Values

errorSocket

public static final int errorSocket
Error due to bad socket specification.

See Also:
Constant Field Values

errorPend

public static final int errorPend
Error waiting for messages to arrive.

See Also:
Constant Field Values

errorIllegalMessageType

public static final int errorIllegalMessageType
Specifying illegal message type.

See Also:
Constant Field Values

errorNoMemory

public static final int errorNoMemory
Error due to no more computer memory.

See Also:
Constant Field Values

errorOutOfRange

public static final int errorOutOfRange
Specifying out-of-range parameter.

See Also:
Constant Field Values

errorLimitExceeded

public static final int errorLimitExceeded
Error due to a limit that was exceeded.

See Also:
Constant Field Values

errorBadDomainId

public static final int errorBadDomainId
Error due to not matching any existing domain.

See Also:
Constant Field Values

errorBadMessage

public static final int errorBadMessage
Error due to message not being in the correct form.

See Also:
Constant Field Values

errorWrongDomainType

public static final int errorWrongDomainType
Specifying a different domain type than expected.

See Also:
Constant Field Values

errorNoClassFound

public static final int errorNoClassFound
Error due to no Java class found for specified subdomain.

See Also:
Constant Field Values

errorDifferentVersion

public static final int errorDifferentVersion
Error due to being different version.

See Also:
Constant Field Values

errorWrongPassword

public static final int errorWrongPassword
Error due to wrong password.

See Also:
Constant Field Values

errorServerDied

public static final int errorServerDied
Error due to server dying.

See Also:
Constant Field Values

errorAbort

public static final int errorAbort
Error due to aborted procedure.

See Also:
Constant Field Values

msgConnectRequest

public static final int msgConnectRequest
Connect to the server from client.

See Also:
Constant Field Values

msgDisconnectRequest

public static final int msgDisconnectRequest
Disconnect client from the server.

See Also:
Constant Field Values

msgKeepAlive

public static final int msgKeepAlive
See if the process on the other end of the socket is still alive.

See Also:
Constant Field Values

msgShutdownClients

public static final int msgShutdownClients
Shutdown various clients.

See Also:
Constant Field Values

msgShutdownServers

public static final int msgShutdownServers
Shutdown various servers.

See Also:
Constant Field Values

msgSendRequest

public static final int msgSendRequest
Send a message.

See Also:
Constant Field Values

msgSyncSendRequest

public static final int msgSyncSendRequest
Send a message with synchronous response.

See Also:
Constant Field Values

msgSubscribeRequest

public static final int msgSubscribeRequest
Subscribe to messages.

See Also:
Constant Field Values

msgUnsubscribeRequest

public static final int msgUnsubscribeRequest
Unsubscribe to messages.

See Also:
Constant Field Values

msgSubscribeAndGetRequest

public static final int msgSubscribeAndGetRequest
Get a message with 1-shot subscribe.

See Also:
Constant Field Values

msgUnsubscribeAndGetRequest

public static final int msgUnsubscribeAndGetRequest
Remove "subscribeAndGet" request.

See Also:
Constant Field Values

msgSendAndGetRequest

public static final int msgSendAndGetRequest
Get a message from a responder of a sent message.

See Also:
Constant Field Values

msgUnSendAndGetRequest

public static final int msgUnSendAndGetRequest
Remove "sendAndGet" request.

See Also:
Constant Field Values

msgMonitorRequest

public static final int msgMonitorRequest
Send "monitor" request.

See Also:
Constant Field Values

msgGetResponse

public static final int msgGetResponse
Respond to a "sendAndGet" request.

See Also:
Constant Field Values

msgSubscribeResponse

public static final int msgSubscribeResponse
Respond with message to the subscribe command.

See Also:
Constant Field Values

msgServerGetResponse

public static final int msgServerGetResponse
Respond to a server's "sendAndGet" request.

See Also:
Constant Field Values

msgRcConnect

public static final int msgRcConnect
Respond to a runcontrol server's "connect" request.

See Also:
Constant Field Values

msgRcAbortConnect

public static final int msgRcAbortConnect
Respond to a runcontrol server's "connect" request.

See Also:
Constant Field Values

msgServerSubscribeRequest

public static final int msgServerSubscribeRequest
Subscribe to messages by another server.

See Also:
Constant Field Values

msgServerUnsubscribeRequest

public static final int msgServerUnsubscribeRequest
Unsubscribe to messages by another server.

See Also:
Constant Field Values

msgServerSubscribeAndGetRequest

public static final int msgServerSubscribeAndGetRequest
SubscribeAndGet a message by another server.

See Also:
Constant Field Values

msgServerUnsubscribeAndGetRequest

public static final int msgServerUnsubscribeAndGetRequest
UnsubscribeAndGet to a message by another server.

See Also:
Constant Field Values

msgServerConnectRequest

public static final int msgServerConnectRequest
Connect to the server from server.

See Also:
Constant Field Values

msgServerDisconnectRequest

public static final int msgServerDisconnectRequest
Disconnect server from the server.

See Also:
Constant Field Values

msgServerRegisterClient

public static final int msgServerRegisterClient
Register client from another server.

See Also:
Constant Field Values

msgServerUnRegisterClient

public static final int msgServerUnRegisterClient
Unregister client from another server.

See Also:
Constant Field Values

msgServerSendClientNames

public static final int msgServerSendClientNames
Send names of local clients.

See Also:
Constant Field Values

msgServerRegistrationLock

public static final int msgServerRegistrationLock
Lock server from doing other registrations.

See Also:
Constant Field Values

msgServerRegistrationUnlock

public static final int msgServerRegistrationUnlock
Unlock server for doing other registrations.

See Also:
Constant Field Values

msgServerCloudLock

public static final int msgServerCloudLock
Lock server from joining server cloud or accepting registrations.

See Also:
Constant Field Values

msgServerCloudUnlock

public static final int msgServerCloudUnlock
Unlock server for joining server cloud or accepting registrations.

See Also:
Constant Field Values

msgServerCloudSetStatus

public static final int msgServerCloudSetStatus
Unlock server for joining server cloud or accepting registrations.

See Also:
Constant Field Values

msgServerSendAndGetRequest

public static final int msgServerSendAndGetRequest
SendAndGet a message by another server.

See Also:
Constant Field Values

msgServerUnSendAndGetRequest

public static final int msgServerUnSendAndGetRequest
UnSendAndGet to a message by another server.

See Also:
Constant Field Values

msgServerShutdownClients

public static final int msgServerShutdownClients
Shutdown various clients.

See Also:
Constant Field Values

msgServerShutdownSelf

public static final int msgServerShutdownSelf
Shutdown various servers.

See Also:
Constant Field Values

includeMe

public static final int includeMe
For shutdownClients, do NOT exclude the client calling shutdown from being shutdown.

See Also:
Constant Field Values

includeMyServer

public static final int includeMyServer
For shutdownServers, do NOT exclude the server that the calling client is connected to from being shutdown.

See Also:
Constant Field Values

payloadStr

public static final int payloadStr
String item in cMsg message payload.

See Also:
Constant Field Values

payloadFlt

public static final int payloadFlt
4-byte float item in cMsg message payload.

See Also:
Constant Field Values

payloadDbl

public static final int payloadDbl
8 byte double item in cMsg message payload.

See Also:
Constant Field Values

payloadInt8

public static final int payloadInt8
1 byte signed integer item in cMsg message payload.

See Also:
Constant Field Values

payloadInt16

public static final int payloadInt16
2 byte signed integer item in cMsg message payload.

See Also:
Constant Field Values

payloadInt32

public static final int payloadInt32
4 byte signed integer item in cMsg message payload.

See Also:
Constant Field Values

payloadInt64

public static final int payloadInt64
8 byte signed integer item in cMsg message payload.

See Also:
Constant Field Values

payloadUint8

public static final int payloadUint8
1 byte unsigned integer item in cMsg message payload.

See Also:
Constant Field Values

payloadUint16

public static final int payloadUint16
2 byte unsigned integer item in cMsg message payload.

See Also:
Constant Field Values

payloadUint32

public static final int payloadUint32
4 byte unsigned integer item in cMsg message payload.

See Also:
Constant Field Values

payloadUint64

public static final int payloadUint64
8 byte unsigned integer item in cMsg message payload.

See Also:
Constant Field Values

payloadMsg

public static final int payloadMsg
cMsg message in cMsg message payload.

See Also:
Constant Field Values

payloadBin

public static final int payloadBin
Binary array in cMsg message payload.

See Also:
Constant Field Values

payloadStrA

public static final int payloadStrA
String array item in cMsg message payload.

See Also:
Constant Field Values

payloadFltA

public static final int payloadFltA
4-byte float array item in cMsg message payload.

See Also:
Constant Field Values

payloadDblA

public static final int payloadDblA
8 byte double array item in cMsg message payload.

See Also:
Constant Field Values

payloadInt8A

public static final int payloadInt8A
1 byte signed integer array item in cMsg message payload.

See Also:
Constant Field Values

payloadInt16A

public static final int payloadInt16A
2 byte signed integer array item in cMsg message payload.

See Also:
Constant Field Values

payloadInt32A

public static final int payloadInt32A
4 byte signed integer array item in cMsg message payload.

See Also:
Constant Field Values

payloadInt64A

public static final int payloadInt64A
8 byte signed integer array item in cMsg message payload.

See Also:
Constant Field Values

payloadUint8A

public static final int payloadUint8A
1 byte unsigned integer array item in cMsg message payload.

See Also:
Constant Field Values

payloadUint16A

public static final int payloadUint16A
2 byte unsigned integer array item in cMsg message payload.

See Also:
Constant Field Values

payloadUint32A

public static final int payloadUint32A
4 byte unsigned integer array item in cMsg message payload.

See Also:
Constant Field Values

payloadUint64A

public static final int payloadUint64A
8 byte unsigned integer array item in cMsg message payload.

See Also:
Constant Field Values

payloadMsgA

public static final int payloadMsgA
cMsg message array in cMsg message payload.

See Also:
Constant Field Values