| Package | Description |
|---|---|
| org.jlab.coda.cMsg | |
| org.jlab.coda.cMsg.apps |
| Modifier and Type | Method and Description |
|---|---|
void |
cMsg.connect()
Method to connect to a particular domain.
|
static java.lang.String |
cMsgUtilities.constructServerName(java.lang.String s)
This method tests its input argument to see if it is in the proper format
for a server; namely, "host:port".
|
void |
cMsg.disconnect()
Method to close the connection to the domain.
|
void |
cMsg.flush(int timeout)
Method to force cMsg client to send pending communications with domain.
|
java.math.BigInteger |
cMsgPayloadItem.getBigInt()
Gets the payload item as a BigInteger object.
|
java.math.BigInteger[] |
cMsgPayloadItem.getBigIntArray()
Gets the payload item as an array of BigInteger objects.
|
byte[] |
cMsgPayloadItem.getBinary()
Gets the payload item as a byte array object holding binary data.
|
byte[][] |
cMsgPayloadItem.getBinaryArray()
Gets the payload item as an array of byte array objects holding binary data.
|
static java.lang.String |
cMsgUtilities.getBroadcastAddress(java.lang.String ip)
Given a local IP address as an argument, this method will return its
broadcast or subnet address.
|
byte |
cMsgPayloadItem.getByte()
Gets the payload item as a byte (8-bit integer).
|
byte[] |
cMsgPayloadItem.getByteArray()
Gets the payload item as an array of bytes (8-bit integers).
|
double |
cMsgPayloadItem.getDouble()
Gets the payload item as a double.
|
double[] |
cMsgPayloadItem.getDoubleArray()
Gets the payload item as an array of doubles.
|
float |
cMsgPayloadItem.getFloat()
Gets the payload item as a float.
|
float[] |
cMsgPayloadItem.getFloatArray()
Gets the payload item as an array of floats.
|
int |
cMsgPayloadItem.getInt()
Gets the payload item as a int (32-bit integer).
|
int[] |
cMsgPayloadItem.getIntArray()
Gets the payload item as an array of ints (32-bit integers).
|
long |
cMsgPayloadItem.getLong()
Gets the payload item as a long (64-bit integer).
|
long[] |
cMsgPayloadItem.getLongArray()
Gets the payload item as an array of longs (64-bit integers).
|
static java.lang.String |
cMsgUtilities.getMatchingLocalIpAddress(java.lang.String ip)
Given an IP address as an argument, this method will return that if it matches
one of the local IP addresses.
|
cMsgMessage |
cMsgPayloadItem.getMessage()
Gets the payload item as a cMsgMessage object.
|
cMsgMessage[] |
cMsgPayloadItem.getMessageArray()
Gets the payload item as an array of cMsgMessage objects.
|
short |
cMsgPayloadItem.getShort()
Gets the payload item as a short (16-bit integer).
|
short[] |
cMsgPayloadItem.getShortArray()
Gets the payload item as an array of shorts (16-bit integers).
|
java.lang.String |
cMsgPayloadItem.getString()
Gets the payload item as a String object.
|
java.lang.String[] |
cMsgPayloadItem.getStringArray()
Gets the payload item as an array of String objects.
|
cMsgMessage |
cMsg.monitor(java.lang.String command)
This method is a synchronous call to receive a message containing monitoring data
which describes the state of the domain the user is connected to.
|
cMsgMessage |
cMsgMessage.nullResponse()
Creates a proper response message to this message which was sent by a client calling
sendAndGet.
|
java.lang.String |
cMsgMessage.payloadToString()
This method converts the message payload to a printable string in XML format.
|
cMsgMessage |
cMsgMessage.response()
Creates a proper response message to this message which was sent by a client calling
sendAndGet.
|
void |
cMsg.send(cMsgMessage message)
Method to send a message to the domain for further distribution.
|
cMsgMessage |
cMsg.sendAndGet(cMsgMessage message,
int timeout)
The message is sent as it would be in the
cMsg.send(cMsgMessage) method. |
void |
cMsgMessage.setByteArray(byte[] b,
int offset,
int length)
Copy byte array into message by copying "length" number of elements
starting at "offset".
|
void |
cMsgMessage.setByteArray(java.nio.ByteBuffer buf)
Copy buffer data into message's byte array.
|
void |
cMsgMessage.setByteArrayEndian(int endian)
Set endianness of the byte array data.
|
void |
cMsgMessage.setByteArrayLength(int length)
Set byte array length of data of interest.
|
void |
cMsgMessage.setByteArrayNoCopy(byte[] b,
int offset,
int length)
Set byte array to the given argument without copying the byte array
itself - only the reference is copied.
|
void |
cMsgMessage.setByteArrayOffset(int offset)
Set byte array index to region of interest.
|
void |
cMsgMessage.setHistoryLengthMax(int historyLengthMax)
Sets the maximum number of entries this message keeps of its history of various parameters.
|
void |
cMsg.setUDL(java.lang.String UDL)
Set the UDL of the client.
|
void |
cMsg.shutdownClients(java.lang.String client,
boolean includeMe)
Method to shutdown the given clients.
|
void |
cMsg.shutdownServers(java.lang.String server,
boolean includeMyServer)
Method to shutdown the given servers.
|
cMsgSubscriptionHandle |
cMsg.subscribe(java.lang.String subject,
java.lang.String type,
cMsgCallbackInterface cb,
java.lang.Object userObj)
Method to subscribe to receive messages of a subject and type from the domain.
|
cMsgMessage |
cMsg.subscribeAndGet(java.lang.String subject,
java.lang.String type,
int timeout)
This method is like a one-time subscribe.
|
int |
cMsg.syncSend(cMsgMessage message,
int timeout)
Method to send a message to the domain for further distribution
and wait for a response from the domain that got it.
|
void |
cMsg.unsubscribe(cMsgSubscriptionHandle handle)
Method to unsubscribe a previous subscription to receive messages of a subject and type
from the domain.
|
| Constructor and Description |
|---|
cMsg(java.lang.String UDL,
java.lang.String name,
java.lang.String description)
Constructor which creates the object used to connect to the UDL (domain) specified.
|
cMsgPayloadItem(java.lang.String name,
java.math.BigInteger big)
Construct a payload item from an unsigned 64-bit integer.
|
cMsgPayloadItem(java.lang.String name,
java.math.BigInteger[] bigs)
Construct a payload item from an array of unsigned 64-bit integers.
|
cMsgPayloadItem(java.lang.String name,
byte b)
Construct a payload item from an 8-bit integer.
|
cMsgPayloadItem(java.lang.String name,
byte[] b)
Construct a payload item from an array of 8-bit integers.
|
cMsgPayloadItem(java.lang.String name,
byte[][] b)
Construct a payload item from an array of byte arrays containing binary data.
|
cMsgPayloadItem(java.lang.String name,
byte[][] b,
int[] end)
Construct a payload item from an array of byte arrays containing binary data.
|
cMsgPayloadItem(java.lang.String name,
byte[] b,
int end)
Construct a payload item from a byte array containing binary data.
|
cMsgPayloadItem(java.lang.String name,
cMsgMessage msg)
Construct a payload item from a cMsgMessage object.
|
cMsgPayloadItem(java.lang.String name,
cMsgMessage[] msgs)
Construct a payload item from an array of cMsgMessage objects.
|
cMsgPayloadItem(java.lang.String name,
double d)
Construct a payload item from a double.
|
cMsgPayloadItem(java.lang.String name,
double[] d)
Construct a payload item from an array of doubles.
|
cMsgPayloadItem(java.lang.String name,
float f)
Construct a payload item from a float.
|
cMsgPayloadItem(java.lang.String name,
float[] f)
Construct a payload item from an array of floats.
|
cMsgPayloadItem(java.lang.String name,
int i)
Construct a payload item from a 32-bit integer.
|
cMsgPayloadItem(java.lang.String name,
int[] i)
Construct a payload item from an array of 32-bit integers.
|
cMsgPayloadItem(java.lang.String name,
long l)
Construct a payload item from a 64-bit integer.
|
cMsgPayloadItem(java.lang.String name,
long[] l)
Construct a payload item from an array of 64-bit integers.
|
cMsgPayloadItem(java.lang.String name,
short s)
Construct a payload item from a 16-bit integer.
|
cMsgPayloadItem(java.lang.String name,
short[] s)
Construct a payload item from an array of 16-bit integers.
|
cMsgPayloadItem(java.lang.String name,
java.lang.String s)
Construct a payload item from a String object.
|
cMsgPayloadItem(java.lang.String name,
java.lang.String[] s)
Construct a payload item from a String array.
|
cMsgPayloadItem(java.lang.String name,
T[] ta)
Construct a payload item from an array of objects implementing the Number interface.
|
| Modifier and Type | Method and Description |
|---|---|
void |
cMsgConsumer.run()
This method is executed as a thread.
|
void |
cMsgProducer.run()
This method is executed as a thread.
|
void |
cMsgGetResponder.run()
This method is executed as a thread.
|
void |
cMsgMonitor.run()
This method is executed as a thread.
|
void |
cMsgGetConsumer.run()
This method is executed as a thread.
|
void |
rcClientKiller.run() |
void |
cMsgPayloadProducer.run()
This method is executed as a thread.
|
void |
cMsgShutdowner.run()
Run as a stand-alone application.
|