// Version: $Id: FlowControl.txt,v 1.3 2005/08/15 13:20:19 belaban Exp $
// Author: Bela Ban


Flow control (FC)
=================



Constants:
----------
- max_credits (example 2000000)
- min_credits (example  200000)


Vars:
-----
- sent_msgs: Map<Address,Long>, maps destinations to credits
- received_msgs: Map<Address,Long>, maps receivers to credits
- running: termination condition
- insufficient_credit: condition, message sending blocks when true
- creditors: list of destination for which we current don't have enough credits to send messages
- lowest_credit: the lowest credits of any destination (sent_msgs)
- mutex: for blocking of a sender


Init:
-----
- running = true
- insufficient_credit = false
- lowest_credit = max_credits


On message send:
----------------
- length = length of message
- if (lowest_credit - length <= 0):
  - insufficient_credit = true
  [- determine creditors]
  - while (insufficient_credit and running):
    - wait on mutex (timeout)
    - if timeout: send credit request to all creditors
- else
  - in sent_msgs: decrement length from all members (if multicast) or specific member (if unicast)
  - adjust lowest_credit

- send message



On message receive:
-------------------
- length = length of message
- sender = sender of message
- in received_msgs: subtract length from sender M
  - if M doesn't have enough credits (credits left <= min_credits):
    - send credits to M
    - replenish credits for M (in received_msgs)


On credit receive from P:
-------------------------
- in sent_msgs: update credits for P
- compute lowest_credit
- remove P from creditors
- if (lowest_credit > 0 and creditor.size() == 0):
  - set insufficient_credit = false
  - notify mutex


On credit request receive from P:
---------------------------------
- send credits to P


On view change:
---------------
- Remove all entries from sent_msgs, received_msgs which are not in the new view
- Add entries for all members of the new view for which there are currently no entries
- Remove all creditors which are not in the new view
- Compute lowest_credit
- if (lowest_credit > 0 and creditor.size() == 0):
  - set insufficient_credit = false
  - notify mutex

On stop:
--------
- Set running = false
- Notify mutex