guarana.toolkit.task.communicators
Class OutCommunicator

java.lang.Object
  extended by guarana.util.observer.smart.SmartObservable
      extended by guarana.framework.task.Task
          extended by guarana.toolkit.task.communicators.Communicator
              extended by guarana.toolkit.task.communicators.OutCommunicator
All Implemented Interfaces:
ISource, IStubOut, guarana.util.observer.smart.ISmartObserver, Remote

public class OutCommunicator
extends Communicator
implements IStubOut

A communicator to send messages in an ExitPorts.
It provides active and passive interfaces.

Graphical notation:

Since:
Guaranį SDK 1.0.0
Author:
Rafael Z. Frantz

Field Summary
 
Fields inherited from class guarana.framework.task.Task
input, output
 
Constructor Summary
OutCommunicator(String name, IExitAdapter adapter)
          Constructs a new Active Communicator to send messages.
OutCommunicator(String name, String host, int port)
          Constructs a new Passive Communicator to send messages and exports this communicator to the RMI Registry.
 
Method Summary
 void execute()
          This method executes the business logic of this task.
 Message<?> fetch()
          This method can be invoked to fetch a message from a passive ExitPort via an Out-Communicator task.
 void update(guarana.util.observer.smart.SmartObservable slot, Object arg)
          This method is automatically called by the observable slot to notify the slot has received a message.
 
Methods inherited from class guarana.framework.task.Task
doWork, getName, getTriggerInterval, isTriggerTask, setName, setTriggerInterval
 
Methods inherited from class guarana.util.observer.smart.SmartObservable
addSmartObserver, containsSmartObserver, containsSmartObserver, countSmartObservers, deleteSmartObserver, deleteSmartObservers, hasChanged, notifySmartObservers, notifySmartObservers
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OutCommunicator

public OutCommunicator(String name,
                       String host,
                       int port)
Constructs a new Passive Communicator to send messages and exports this communicator to the RMI Registry.

Parameters:
name - The name of the communicator.
host - The host name on which the registry is running
port - The port on which the registry accepts requests

OutCommunicator

public OutCommunicator(String name,
                       IExitAdapter adapter)
Constructs a new Active Communicator to send messages.

Parameters:
name - The name of the communicator.
adapter - The adapter used by the communicator.
Method Detail

execute

public void execute()
             throws TaskExecutionException
This method executes the business logic of this task. It is automatically invoked by workers.

Overrides:
execute in class Task
Throws:
TaskExecutionException - to report any exception that has occurred during the execution of this method.
See Also:
TaskExecutionException

fetch

public Message<?> fetch()
                 throws RemoteException
This method can be invoked to fetch a message from a passive ExitPort via an Out-Communicator task.

Specified by:
fetch in interface IStubOut
Returns:
the outbound message or null if there is no message.
Throws:
RemoteException - if any remote exception is raised by the method execution.
See Also:
IStubOut.fetch()

update

public void update(guarana.util.observer.smart.SmartObservable slot,
                   Object arg)
This method is automatically called by the observable slot to notify the slot has received a message. For all those tasks that can execute with one or more messages in its input slots, this method will add the task to the executable task reporter, so it can be executed. In this case the task execution will consume messages from all input slots.
Please, do not call this method by yourself. Overrides the implementation at Task for performance reasons.

Specified by:
update in interface guarana.util.observer.smart.ISmartObserver
Overrides:
update in class Task
Parameters:
slot - The Slot associated with this task.
arg - THIS PARAMETHER IS NOT USED.


Guaranį DSL Home