fr.dyade.aaa.agent.DriverIn Class Reference

Inherits fr.dyade.aaa.agent.Driver.

Inheritance diagram for fr.dyade.aaa.agent.DriverIn:

Inheritance graph
[legend]
Collaboration diagram for fr.dyade.aaa.agent.DriverIn:

Collaboration graph
[legend]
List of all members.

Public Member Functions

String toString ()
void run ()
void close ()

Protected Member Functions

void end ()

Protected Attributes

AgentId proxyId
NotificationInputStream in

Package Functions

 DriverIn (int id, ProxyAgent proxy, NotificationInputStream in, int maxNotSent)
 DriverIn (int id, ProxyAgent proxy, NotificationInputStream in, int maxNotSent, int key)
synchronized void sendFlowControl () throws IOException
synchronized void recvFlowControl (FlowControlNot not)

Package Attributes

int nbNotSent = 0
int maxNotSent = 0
int nbFlowControl = 0

Detailed Description

Input driver.

Definition at line 30 of file DriverIn.java.


Constructor & Destructor Documentation

fr.dyade.aaa.agent.DriverIn.DriverIn ( int  id,
ProxyAgent  proxy,
NotificationInputStream  in,
int  maxNotSent 
) [package]

Constructor.

Parameters:
id identifier local to the driver creator
proxy proxy agent to forward notifications to
in stream to read notifications from
maxNotSent max number of notifications between FlowControls

Definition at line 67 of file DriverIn.java.

References fr.dyade.aaa.agent.Agent.getId(), fr.dyade.aaa.agent.ProxyAgent.getLogTopic(), fr.dyade.aaa.agent.Agent.getName(), fr.dyade.aaa.agent.DriverIn.in, and fr.dyade.aaa.agent.Driver.logmon.

Here is the call graph for this function:

fr.dyade.aaa.agent.DriverIn.DriverIn ( int  id,
ProxyAgent  proxy,
NotificationInputStream  in,
int  maxNotSent,
int  key 
) [package]

Constructor called by a ProxyAgent managing multiple connections.

Parameters:
id identifier local to the driver creator
proxy proxy agent to forward notifications to
in stream to read notifications from
maxNotSent max number of notifications between FlowControls
key key identifying the connection.

Definition at line 93 of file DriverIn.java.

References fr.dyade.aaa.agent.DriverIn.in.


Member Function Documentation

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

Provides a string image for this object.

Returns:
printable image of this object

Reimplemented from fr.dyade.aaa.agent.Driver.

Definition at line 107 of file DriverIn.java.

References fr.dyade.aaa.agent.DriverIn.maxNotSent, fr.dyade.aaa.agent.DriverIn.nbFlowControl, and fr.dyade.aaa.agent.DriverIn.nbNotSent.

void fr.dyade.aaa.agent.DriverIn.run (  )  [virtual]

Actually executes the driver code. To be defined in derived classes.

Beware: this code is executed in a separate thread, outside from any transaction. Notifications may be sent using function sendTo, and they will actually be sent as soon as the function is called; there is no atomic treatment as there is in an agent reaction.

Exceptions:
Exception unspecialized exception

Implements fr.dyade.aaa.agent.Driver.

Definition at line 145 of file DriverIn.java.

References fr.dyade.aaa.agent.Driver.canStop, fr.dyade.aaa.agent.ProxyAgent.driverReact(), fr.dyade.aaa.agent.ProxyAgent.finalizing, fr.dyade.aaa.agent.Driver.getName(), fr.dyade.aaa.agent.DriverIn.in, fr.dyade.aaa.agent.Driver.isRunning, fr.dyade.aaa.agent.Driver.logmon, fr.dyade.aaa.agent.DriverIn.maxNotSent, fr.dyade.aaa.agent.DriverIn.nbNotSent, fr.dyade.aaa.agent.NotificationInputStream.readNotification(), and fr.dyade.aaa.agent.DriverIn.sendFlowControl().

Here is the call graph for this function:

void fr.dyade.aaa.agent.DriverIn.end (  )  [protected]

Finalizes the driver.

Reports driver end to the proxy agent, with a DriverDone notification.

Reimplemented from fr.dyade.aaa.agent.Driver.

Definition at line 195 of file DriverIn.java.

References fr.dyade.aaa.agent.Driver.getName(), fr.dyade.aaa.agent.Driver.logmon, fr.dyade.aaa.agent.DriverIn.proxyId, and fr.dyade.aaa.agent.Driver.sendTo().

Here is the call graph for this function:

void fr.dyade.aaa.agent.DriverIn.close (  )  [virtual]

Close the OutputStream.

Implements fr.dyade.aaa.agent.Driver.

Definition at line 217 of file DriverIn.java.

References fr.dyade.aaa.agent.NotificationInputStream.close(), and fr.dyade.aaa.agent.DriverIn.in.

Here is the call graph for this function:


Member Data Documentation

AgentId fr.dyade.aaa.agent.DriverIn.proxyId [protected]

Id of proxy this DriverIn belongs to.

Definition at line 36 of file DriverIn.java.

Referenced by fr.dyade.aaa.agent.DriverIn.end(), and fr.dyade.aaa.agent.DriverIn.sendFlowControl().

NotificationInputStream fr.dyade.aaa.agent.DriverIn.in [protected]

stream to read notifications from

Definition at line 39 of file DriverIn.java.

Referenced by fr.dyade.aaa.agent.DriverIn.close(), fr.dyade.aaa.agent.DriverIn.DriverIn(), and fr.dyade.aaa.agent.DriverIn.run().

int fr.dyade.aaa.agent.DriverIn.nbNotSent = 0 [package]

number of notifications sent since last sent FlowControl

Definition at line 42 of file DriverIn.java.

Referenced by fr.dyade.aaa.agent.DriverIn.run(), and fr.dyade.aaa.agent.DriverIn.toString().

int fr.dyade.aaa.agent.DriverIn.maxNotSent = 0 [package]

max number of notifications between two FlowControls

Definition at line 45 of file DriverIn.java.

Referenced by fr.dyade.aaa.agent.DriverIn.run(), and fr.dyade.aaa.agent.DriverIn.toString().

int fr.dyade.aaa.agent.DriverIn.nbFlowControl = 0 [package]

number of FlowControls sent and not received by proxy

Definition at line 48 of file DriverIn.java.

Referenced by fr.dyade.aaa.agent.DriverIn.recvFlowControl(), fr.dyade.aaa.agent.DriverIn.sendFlowControl(), and fr.dyade.aaa.agent.DriverIn.toString().


The documentation for this class was generated from the following file:
Generated on Tue Sep 16 16:16:22 2008 for joram by  doxygen 1.5.0