From 26732f2fdd4720deee653ab96cd453ed65dcaa87 Mon Sep 17 00:00:00 2001
From: Vlad Dumitrescu
* Provides a carrier for Erlang messages.
*
* Instances of this class are created to package header and payload information
* in received Erlang messages so that the recipient can obtain both parts with
* a single call to {@link OtpMbox#receiveMsg receiveMsg()}.
*
- * The header information that is available is as follows:
* Message are sent using the Erlang external format (see separate
* documentation). When a message is received and delivered to the recipient
@@ -68,87 +70,87 @@ public class OtpMsg {
// send has receiver pid but no sender information
OtpMsg(final OtpErlangPid to, final OtpInputStream paybuf) {
- tag = sendTag;
- from = null;
- this.to = to;
- toName = null;
- this.paybuf = paybuf;
- payload = null;
+ tag = sendTag;
+ from = null;
+ this.to = to;
+ toName = null;
+ this.paybuf = paybuf;
+ payload = null;
}
// send has receiver pid but no sender information
OtpMsg(final OtpErlangPid to, final OtpErlangObject payload) {
- tag = sendTag;
- from = null;
- this.to = to;
- toName = null;
- paybuf = null;
- this.payload = payload;
+ tag = sendTag;
+ from = null;
+ this.to = to;
+ toName = null;
+ paybuf = null;
+ this.payload = payload;
}
// send_reg has sender pid and receiver name
OtpMsg(final OtpErlangPid from, final String toName,
- final OtpInputStream paybuf) {
- tag = regSendTag;
- this.from = from;
- this.toName = toName;
- to = null;
- this.paybuf = paybuf;
- payload = null;
+ final OtpInputStream paybuf) {
+ tag = regSendTag;
+ this.from = from;
+ this.toName = toName;
+ to = null;
+ this.paybuf = paybuf;
+ payload = null;
}
// send_reg has sender pid and receiver name
OtpMsg(final OtpErlangPid from, final String toName,
- final OtpErlangObject payload) {
- tag = regSendTag;
- this.from = from;
- this.toName = toName;
- to = null;
- paybuf = null;
- this.payload = payload;
+ final OtpErlangObject payload) {
+ tag = regSendTag;
+ this.from = from;
+ this.toName = toName;
+ to = null;
+ paybuf = null;
+ this.payload = payload;
}
// exit (etc) has from, to, reason
OtpMsg(final int tag, final OtpErlangPid from, final OtpErlangPid to,
- final OtpErlangObject reason) {
- this.tag = tag;
- this.from = from;
- this.to = to;
- paybuf = null;
- payload = reason;
+ final OtpErlangObject reason) {
+ this.tag = tag;
+ this.from = from;
+ this.to = to;
+ paybuf = null;
+ payload = reason;
}
// special case when reason is an atom (i.e. most of the time)
OtpMsg(final int tag, final OtpErlangPid from, final OtpErlangPid to,
- final String reason) {
- this.tag = tag;
- this.from = from;
- this.to = to;
- paybuf = null;
- payload = new OtpErlangAtom(reason);
+ final String reason) {
+ this.tag = tag;
+ this.from = from;
+ this.to = to;
+ paybuf = null;
+ payload = new OtpErlangAtom(reason);
}
// other message types (link, unlink)
OtpMsg(final int tag, final OtpErlangPid from, final OtpErlangPid to) {
- // convert TT-tags to equiv non-TT versions
- int atag = tag;
- if (tag > 10) {
- atag -= 10;
- }
+ // convert TT-tags to equiv non-TT versions
+ int atag = tag;
+ if (tag > 10) {
+ atag -= 10;
+ }
- this.tag = atag;
- this.from = from;
- this.to = to;
+ this.tag = atag;
+ this.from = from;
+ this.to = to;
}
/**
* Get the payload from this message without deserializing it.
- *
+ *
* @return the serialized Erlang term contained in this message.
- *
+ *
*/
OtpInputStream getMsgBuf() {
- return paybuf;
+ return paybuf;
}
/**
@@ -157,36 +159,37 @@ public class OtpMsg {
* type of message. Valid values are the ``tag'' constants defined in this
* class.
*
* The tab identifies not only the type of message but also the content of
* the OtpMsg object, since different messages have different components, as
* follows:
*
- *
+ *
*
+ *
- *
+ * is {@link OtpMsg#regSendTag regSendTag} contain sender information.
+ *
- *
*/
public int type() {
- return tag;
+ return tag;
}
/**
@@ -194,42 +197,42 @@ public class OtpMsg {
* Deserialize and return a new copy of the message contained in this
* OtpMsg.
*
* The first time this method is called the actual payload is deserialized * and the Erlang term is created. Calling this method subsequent times will * not cuase the message to be deserialized additional times, instead the * same Erlang term object will be returned. *
- * + * * @return an Erlang term. - * + * * @exception OtpErlangDecodeException - * if the byte stream could not be deserialized. - * + * if the byte stream could not be deserialized. + * */ public OtpErlangObject getMsg() throws OtpErlangDecodeException { - if (payload == null) { - payload = paybuf.read_any(); - } - return payload; + if (payload == null) { + payload = paybuf.read_any(); + } + return payload; } /** ** Get the name of the recipient for this message. *
- * + * ** Messages are sent to Pids or names. If this message was sent to a name * then the name is returned by this method. *
- * + * * @return the name of the recipient, or null if the recipient was in fact a * Pid. */ public String getRecipientName() { - return toName; + return toName; } /** @@ -237,18 +240,18 @@ public class OtpMsg { * Get the Pid of the recipient for this message, if it is a sendTag * message. * - * + * ** Messages are sent to Pids or names. If this message was sent to a Pid * then the Pid is returned by this method. The recipient Pid is also * available for link, unlink and exit messages. *
- * + * * @return the Pid of the recipient, or null if the recipient was in fact a * name. */ public OtpErlangPid getRecipientPid() { - return to; + return to; } /** @@ -256,36 +259,36 @@ public class OtpMsg { * Get the name of the recipient for this message, if it is a regSendTag * message. * - * + * ** Messages are sent to Pids or names. If this message was sent to a name * then the name is returned by this method. *
- * + * * @return the Pid of the recipient, or null if the recipient was in fact a * name. */ public Object getRecipient() { - if (toName != null) { - return toName; - } - return to; + if (toName != null) { + return toName; + } + return to; } /** ** Get the Pid of the sender of this message. *
- * + * ** For messages sent to names, the Pid of the sender is included with the * message. The sender Pid is also available for link, unlink and exit * messages. It is not available for sendTag messages sent to Pids. *
- * + * * @return the Pid of the sender, or null if it was not available. */ public OtpErlangPid getSenderPid() { - return from; + return from; } } -- cgit v1.2.3