JACK 5.4 Application Interface

aos.dci
Class Message

java.lang.Object
  extended byaos.dci.Message
All Implemented Interfaces:
aos.apib.Base, java.io.Serializable
Direct Known Subclasses:
EventMessage

public class Message
extends java.lang.Object
implements aos.apib.Base, java.io.Serializable

This is used to send messages between agents. The agents might reside within the same process or they may be on different processes on possibly different machines.

See Also:
Serialized Form

Field Summary
 java.lang.String msgfrom
          Where the message came from.
 java.lang.String msgto
          Where the message is/was heading.
 
Constructor Summary
Message()
           
 
Method Summary
 boolean arrival(Addressable a)
          Called when the message arrives at the destination.
 boolean finish(Addressable a)
          Called when the message has been processed.
 aos.apib.StreamerSupport getStreamer()
          Returns the StreamerSupport for the object implementing this interface.
 java.lang.Object process(Addressable a)
          Called to process the message when it arrives.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

msgfrom

public java.lang.String msgfrom
Where the message came from.


msgto

public java.lang.String msgto
Where the message is/was heading.

Constructor Detail

Message

public Message()
Method Detail

getStreamer

public aos.apib.StreamerSupport getStreamer()
Description copied from interface: aos.apib.Base
Returns the StreamerSupport for the object implementing this interface.

Specified by:
getStreamer in interface aos.apib.Base

arrival

public boolean arrival(Addressable a)
Called when the message arrives at the destination.


process

public java.lang.Object process(Addressable a)
Called to process the message when it arrives.


finish

public boolean finish(Addressable a)
Called when the message has been processed.


JACK 5.4 Application Interface

Copyright (C) 1999-2008, Agent Oriented Software Pty. Ltd.

US Government Restricted Rights
The JACK Modules and relevant Software Material have been developed entirely at private expense and are accordingly provided with RESTRICTED RIGHTS. Use, duplication, or disclosure by Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of DFARS 252.227-7013 or subparagraph (c)(1) and (2) of the Commercial Computer Software Restricted Rights and 48 CFR 52.2270-19, as applicable.


Agent Oriented Software Pty. Ltd.     http://www.aosgrp.com
PO Box 639, Carlton South, Victoria 3053, Australia
Phone: +61 3 9349 5055, Fax: +61 3 9349 5088