fr.dyade.aaa.agent.Message

fr.dyade.aaa.agent.Message Class Reference

Collaboration diagram for fr.dyade.aaa.agent.Message:

Collaboration graph

[legend]List of all members.


Public Member Functions
String	toString ()
StringBuffer	appendToString (StringBuffer strbuf)
Package Functions
short	getSource ()
short	getDest ()
int	getStamp ()
byte	optToByte ()
void	optFromByte (byte opt)
final String	toStringId ()
boolean	isPersistent ()
void	save () throws IOException
void	delete () throws IOException
void	free ()
Static Package Functions
static Message	load (String name) throws IOException, ClassNotFoundException
static Message	alloc ()
static Message	alloc (AgentId from, AgentId to, Notification not)
Package Attributes
transient AgentId	from
transient AgentId	to
transient Notification	not
transient short	source
transient short	dest
transient int	stamp
Static Package Attributes
static final long	serialVersionUID = 1L
static final int	LENGTH = 25
static final byte	NULL = (byte) 0x00
static final byte	NOTNULL = (byte) 0x40
static final byte	PERSISTENT = (byte) 0x01
static final byte	DETACHABLE = (byte) 0x02

Detailed Description

The internal message structure. A message is divided in 2 parts:

An immutable part with source and destination agent unique id, and notification object.
A variable part containing information about message routing (next hop) and the current stamp of the message.

Definition at line 40 of file Message.java.

Member Function Documentation

short fr.dyade.aaa.agent.Message.getSource ( ) [package]

Get the unique server id. of the sender of this message

Definition at line 59 of file Message.java.

References fr.dyade.aaa.agent.Message.source.

Referenced by fr.dyade.aaa.agent.HttpNetwork.handle(), and fr.dyade.aaa.agent.SimpleNetwork.NetworkInputStream.readMessage().

short fr.dyade.aaa.agent.Message.getDest ( ) [package]

Get the unique server id. of the addressee of this message

Definition at line 64 of file Message.java.

References fr.dyade.aaa.agent.Message.dest.

Referenced by fr.dyade.aaa.agent.JGroups.receive(), fr.dyade.aaa.agent.UDPNetwork.NetServerOut.run(), fr.dyade.aaa.agent.SimpleNetwork.NetServerOut.run(), fr.dyade.aaa.agent.NGNetwork.Dispatcher.run(), fr.dyade.aaa.agent.PoolNetwork.PoolSender.send(), and fr.dyade.aaa.agent.SimpleNetwork.NetServerOut.watchdog().

int fr.dyade.aaa.agent.Message.getStamp ( ) [package]

Get the stamp of this message

Definition at line 69 of file Message.java.

References fr.dyade.aaa.agent.Message.stamp.

Referenced by fr.dyade.aaa.agent.MessageVector.insert(), fr.dyade.aaa.agent.JGroupsAckMsg.JGroupsAckMsg(), fr.dyade.aaa.agent.PoolNetwork.MessageVector.removeMessage(), fr.dyade.aaa.agent.NGNetwork.MessageVector.removeMessage(), fr.dyade.aaa.agent.MessageVector.removeMessage(), fr.dyade.aaa.agent.PoolNetwork.NetSession.run(), and fr.dyade.aaa.agent.PoolNetwork.NetSession.send().

String fr.dyade.aaa.agent.Message.toString ( )

Returns a string representation for this object.

Returns:: A string representation of this object.

Definition at line 78 of file Message.java.

References fr.dyade.aaa.agent.Message.appendToString().

Here is the call graph for this function:

StringBuffer fr.dyade.aaa.agent.Message.appendToString ( StringBuffer strbuf )

Adds a string representation for this object in the StringBuffer parameter.

Returns:: A string representation of this object.

Definition at line 88 of file Message.java.

References fr.dyade.aaa.agent.Message.dest, fr.dyade.aaa.agent.Message.from, fr.dyade.aaa.agent.Message.not, fr.dyade.aaa.agent.Message.source, fr.dyade.aaa.agent.Message.stamp, and fr.dyade.aaa.agent.Message.to.

Referenced by fr.dyade.aaa.agent.Message.toString().

boolean fr.dyade.aaa.agent.Message.isPersistent ( ) [package]

Tests if the associated notification is persistent or not.

Returns:: true if the associated notification is persistent.

Definition at line 226 of file Message.java.

References fr.dyade.aaa.agent.Message.not, and fr.dyade.aaa.agent.Notification.persistent.

Referenced by fr.dyade.aaa.agent.Message.delete(), fr.dyade.aaa.agent.JGroupsAckMsg.JGroupsAckMsg(), fr.dyade.aaa.agent.MessageVector.MessageSoftRef.MessageSoftRef(), fr.dyade.aaa.agent.Engine.post(), and fr.dyade.aaa.agent.Message.save().

void fr.dyade.aaa.agent.Message.save ( ) throws IOException [package]

Saves the object state on persistent storage.

Definition at line 233 of file Message.java.

References fr.dyade.aaa.agent.Message.dest, fr.dyade.aaa.agent.Notification.detachable, fr.dyade.aaa.agent.Message.isPersistent(), fr.dyade.aaa.agent.Notification.messageId, fr.dyade.aaa.agent.Message.not, fr.dyade.aaa.agent.Message.stamp, and fr.dyade.aaa.agent.Message.toStringId().

Referenced by fr.dyade.aaa.agent.HAEngine.post(), fr.dyade.aaa.agent.Engine.post(), and fr.dyade.aaa.agent.HAEngine.receiveFromJGroups().

Here is the call graph for this function:

static Message fr.dyade.aaa.agent.Message.load ( String name ) throws IOException, ClassNotFoundException [static, package]

Restores the object state from the persistent storage.

Exceptions:

	IOException	when accessing the stored image
	ClassNotFoundException	if the stored image class may not be found

Definition at line 252 of file Message.java.

References fr.dyade.aaa.agent.Message.dest, fr.dyade.aaa.agent.Notification.detachable, fr.dyade.aaa.agent.Notification.detached, fr.dyade.aaa.agent.Message.load(), fr.dyade.aaa.agent.Notification.messageId, fr.dyade.aaa.agent.Message.not, fr.dyade.aaa.agent.Notification.persistent, fr.dyade.aaa.agent.Message.stamp, and fr.dyade.aaa.agent.Message.toStringId().

Referenced by fr.dyade.aaa.agent.Message.load(), and fr.dyade.aaa.agent.MessageVector.MessageSoftRef.loadMessage().

Here is the call graph for this function:

void fr.dyade.aaa.agent.Message.delete ( ) throws IOException [package]

Deletes the current object in persistent storage.

Definition at line 270 of file Message.java.

References fr.dyade.aaa.agent.Message.delete(), fr.dyade.aaa.agent.Notification.detachable, fr.dyade.aaa.agent.Notification.detached, fr.dyade.aaa.agent.Notification.getMessageId(), fr.dyade.aaa.agent.Message.isPersistent(), fr.dyade.aaa.agent.Message.not, and fr.dyade.aaa.agent.Message.toStringId().

Referenced by fr.dyade.aaa.agent.Engine.abort(), fr.dyade.aaa.agent.GCEngine.commit(), fr.dyade.aaa.agent.Engine.commit(), fr.dyade.aaa.agent.Message.delete(), fr.dyade.aaa.agent.UDPNetwork.NetServerIn.run(), fr.dyade.aaa.agent.SimpleNetwork.NetServerOut.run(), fr.dyade.aaa.agent.PoolNetwork.Dispatcher.run(), fr.dyade.aaa.agent.HttpNetwork.NetServerIn.run(), fr.dyade.aaa.agent.HttpNetwork.NetServerOut.run(), and fr.dyade.aaa.agent.Engine.run().

Here is the call graph for this function:

static Message fr.dyade.aaa.agent.Message.alloc ( ) [static, package]

Allocates a message from the pool.

Definition at line 296 of file Message.java.

References fr.dyade.aaa.util.Pool.allocElement().

Referenced by fr.dyade.aaa.agent.Message.alloc(), and fr.dyade.aaa.agent.Channel.directSendTo().

Here is the call graph for this function:

static Message fr.dyade.aaa.agent.Message.alloc	(	AgentId	from,
		AgentId	to,
		Notification	not
	)			`[static, package]`

Allocates a message from the pool.

Parameters:

	from	id of source Agent.
	to	id of destination Agent.
	not	Notification to be signaled.

Definition at line 314 of file Message.java.

References fr.dyade.aaa.agent.Message.alloc(), fr.dyade.aaa.agent.Message.from, fr.dyade.aaa.agent.Message.not, fr.dyade.aaa.agent.Message.set(), and fr.dyade.aaa.agent.Message.to.

Here is the call graph for this function:

void fr.dyade.aaa.agent.Message.free ( ) [package]

Frees the message to the pool.

Definition at line 323 of file Message.java.

References fr.dyade.aaa.util.Pool.freeElement(), and fr.dyade.aaa.agent.Message.not.

Referenced by fr.dyade.aaa.agent.Engine.abort(), fr.dyade.aaa.agent.GCEngine.commit(), fr.dyade.aaa.agent.Engine.commit(), fr.dyade.aaa.agent.UDPNetwork.NetServerIn.run(), fr.dyade.aaa.agent.PoolNetwork.Dispatcher.run(), fr.dyade.aaa.agent.HttpNetwork.NetServerIn.run(), fr.dyade.aaa.agent.HttpNetwork.NetServerOut.run(), and fr.dyade.aaa.agent.Engine.run().

Here is the call graph for this function:

Member Data Documentation

final long fr.dyade.aaa.agent.Message.serialVersionUID = 1L [static, package]

define serialVersionUID for interoperability

Definition at line 42 of file Message.java.

transient AgentId fr.dyade.aaa.agent.Message.from [package]

AgentId of sender.

Definition at line 45 of file Message.java.

Referenced by fr.dyade.aaa.agent.Engine.abort(), fr.dyade.aaa.agent.Message.alloc(), fr.dyade.aaa.agent.Message.appendToString(), fr.dyade.aaa.agent.Engine.dispatch(), fr.dyade.aaa.agent.UDPNetwork.NetServerOut.run(), fr.dyade.aaa.agent.SimpleNetwork.NetServerOut.run(), fr.dyade.aaa.agent.PoolNetwork.Dispatcher.run(), fr.dyade.aaa.agent.HttpNetwork.NetServerIn.run(), fr.dyade.aaa.agent.HttpNetwork.NetServerOut.run(), and fr.dyade.aaa.agent.Engine.run().

transient AgentId fr.dyade.aaa.agent.Message.to [package]

AgentId of destination agent.

Definition at line 47 of file Message.java.

Referenced by fr.dyade.aaa.agent.Engine.abort(), fr.dyade.aaa.agent.Message.alloc(), fr.dyade.aaa.agent.Message.appendToString(), fr.dyade.aaa.agent.UDPNetwork.NetServerOut.run(), fr.dyade.aaa.agent.SimpleNetwork.NetServerOut.run(), fr.dyade.aaa.agent.PoolNetwork.Dispatcher.run(), fr.dyade.aaa.agent.HttpNetwork.NetServerIn.run(), fr.dyade.aaa.agent.HttpNetwork.NetServerOut.run(), and fr.dyade.aaa.agent.Engine.run().

transient Notification fr.dyade.aaa.agent.Message.not [package]

The notification.

Definition at line 49 of file Message.java.

Referenced by fr.dyade.aaa.agent.Engine.abort(), fr.dyade.aaa.agent.Message.alloc(), fr.dyade.aaa.agent.Message.appendToString(), fr.dyade.aaa.agent.Message.delete(), fr.dyade.aaa.agent.Message.free(), fr.dyade.aaa.agent.PoolNetwork.MessageList.insertAck(), fr.dyade.aaa.agent.PoolNetwork.MessageList.insertMessage(), fr.dyade.aaa.agent.Message.isPersistent(), fr.dyade.aaa.agent.Message.load(), fr.dyade.aaa.agent.Message.optFromByte(), fr.dyade.aaa.agent.Message.optToByte(), fr.dyade.aaa.agent.MessageInputStream.readMessage(), fr.dyade.aaa.agent.NGNetwork.MessageVector.removeMessage(), fr.dyade.aaa.agent.UDPNetwork.NetServerOut.run(), fr.dyade.aaa.agent.SimpleNetwork.NetServerOut.run(), fr.dyade.aaa.agent.PoolNetwork.NetSession.run(), fr.dyade.aaa.agent.PoolNetwork.Dispatcher.run(), fr.dyade.aaa.agent.HttpNetwork.NetServerIn.run(), fr.dyade.aaa.agent.HttpNetwork.NetServerOut.run(), fr.dyade.aaa.agent.Engine.run(), fr.dyade.aaa.agent.Message.save(), fr.dyade.aaa.agent.PoolNetwork.NetSession.send(), and fr.dyade.aaa.agent.PoolNetwork.Sender.send().

transient short fr.dyade.aaa.agent.Message.source [package]

The unique id. of source server

Definition at line 52 of file Message.java.

Referenced by fr.dyade.aaa.agent.Message.appendToString(), fr.dyade.aaa.agent.Message.getSource(), and fr.dyade.aaa.agent.Engine.stamp().

transient short fr.dyade.aaa.agent.Message.dest [package]

The unique id. of destination server

Definition at line 54 of file Message.java.

Referenced by fr.dyade.aaa.agent.Message.appendToString(), fr.dyade.aaa.agent.Message.getDest(), fr.dyade.aaa.agent.Message.load(), fr.dyade.aaa.agent.Message.save(), fr.dyade.aaa.agent.Engine.stamp(), and fr.dyade.aaa.agent.Message.toStringId().

transient int fr.dyade.aaa.agent.Message.stamp [package]

The current stamp of the message

Definition at line 56 of file Message.java.

Referenced by fr.dyade.aaa.agent.Message.appendToString(), fr.dyade.aaa.agent.Message.getStamp(), fr.dyade.aaa.agent.HttpNetwork.handle(), fr.dyade.aaa.agent.PoolNetwork.MessageList.insertAck(), fr.dyade.aaa.agent.PoolNetwork.MessageList.insertMessage(), fr.dyade.aaa.agent.Message.load(), fr.dyade.aaa.agent.Message.save(), fr.dyade.aaa.agent.PoolNetwork.NetSession.send(), fr.dyade.aaa.agent.Engine.stamp(), and fr.dyade.aaa.agent.Message.toStringId().

The documentation for this class was generated from the following file:

fr/dyade/aaa/agent/Message.java

Generated on Tue Sep 16 16:16:31 2008 for joram by

doxygen

1.5.0