FC

java.lang.Object
- com.fr.third.jgroups.stack.Protocol
- - com.fr.third.jgroups.protocols.FC

已过时。
Succeeded by MFC and UFC
```
@Deprecated
public class FC
extends Protocol
```
Simple flow control protocol based on a credit system. Each sender has a number of credits (bytes to send). When the credits have been exhausted, the sender blocks. Each receiver also keeps track of how many credits it has received from a sender. When credits for a sender fall below a threshold, the receiver sends more credits to the sender. Works for both unicast and multicast messages.
Note that this protocol must be located towards the top of the stack, or all down_threads from JChannel to this protocol must be set to false ! This is in order to block JChannel.send()/JChannel.down().
This is the second simplified implementation of the same model. The algorithm is sketched out in doc/FlowControl.txt
Changes (Brian) April 2006:
1. Receivers now send credits to a sender when more than min_credits have been received (rather than when min_credits are left)
2. Receivers don't send the full credits (max_credits), but rather tha actual number of bytes received
作者:

Bela Ban

字段概要
- 从类继承的字段 com.fr.third.jgroups.stack.Protocol
  down_prot, ergonomics, id, log, name, stack, stats, up_prot

构造器概要

构造器
构造器和说明

FC()
已过时。

构造器
构造器和说明
`FC()` 已过时。

方法概要

方法
限定符和类型	方法和说明
`java.lang.Object`	`down(Event evt)` 已过时。 An event is to be sent down the stack.
`java.util.Map<java.lang.String,java.lang.Object>`	`dumpStats()` 已过时。
`double`	`getAverageTimeBlocked()` 已过时。
`long`	`getMaxBlockTime()` 已过时。
`java.lang.String`	`getMaxBlockTimes()` 已过时。
`long`	`getMaxCredits()` 已过时。
`long`	`getMinCredits()` 已过时。
`double`	`getMinThreshold()` 已过时。
`int`	`getNumberOfBlockings()` 已过时。
`int`	`getNumberOfCreditRequestsReceived()` 已过时。
`int`	`getNumberOfCreditRequestsSent()` 已过时。
`int`	`getNumberOfCreditResponsesReceived()` 已过时。
`int`	`getNumberOfCreditResponsesSent()` 已过时。
`long`	`getTotalTimeBlocked()` 已过时。
`protected void`	`handleUpEvent(FcHeader hdr, Message msg)` 已过时。
`void`	`init()` 已过时。 Called after instance has been created (null constructor) and before protocol is started.
`java.lang.String`	`printCreditors()` 已过时。
`java.lang.String`	`printCredits()` 已过时。
`java.lang.String`	`printReceiverCredits()` 已过时。
`java.lang.String`	`printSenderCredits()` 已过时。
`void`	`resetStats()` 已过时。
`void`	`setMaxBlockTime(long t)` 已过时。
`void`	`setMaxBlockTimes(java.lang.String str)` 已过时。
`void`	`setMaxCredits(long max_credits)` 已过时。
`void`	`setMinCredits(long min_credits)` 已过时。
`void`	`setMinThreshold(double min_threshold)` 已过时。
`java.lang.String`	`showLastBlockingTimes()` 已过时。
`void`	`start()` 已过时。 This method is called on a `Channel.connect(String)`.
`void`	`stop()` 已过时。 This method is called on a `Channel.disconnect()`.
`void`	`unblock()` 已过时。 Allows to unblock a blocked sender from an external program, e.g.
`java.lang.Object`	`up(Event evt)` 已过时。 An event was received from the layer below.
`void`	`up(MessageBatch batch)` 已过时。 Sends up a multiple messages in a `MessageBatch`.

从类继承的方法 com.fr.third.jgroups.stack.Protocol
accept, destroy, enableStats, getConfigurableObjects, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getName, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, isErgonomics, level, parse, printStats, providedDownServices, providedUpServices, requiredDownServices, requiredUpServices, resetStatistics, setDownProtocol, setErgonomics, setId, setLevel, setProtocolStack, setSocketFactory, setUpProtocol, setValue, setValues, statsEnabled

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - FC
```
public FC()
```
    已过时。
- 方法详细资料
  - resetStats
```
public void resetStats()
```
    已过时。
    
    覆盖:
    
    resetStats 在类中 Protocol
  - getMaxCredits
```
public long getMaxCredits()
```
    已过时。
  - setMaxCredits
```
public void setMaxCredits(long max_credits)
```
    已过时。
  - getMinThreshold
```
public double getMinThreshold()
```
    已过时。
  - setMinThreshold
```
public void setMinThreshold(double min_threshold)
```
    已过时。
  - getMinCredits
```
public long getMinCredits()
```
    已过时。
  - setMinCredits
```
public void setMinCredits(long min_credits)
```
    已过时。
  - getNumberOfBlockings
```
public int getNumberOfBlockings()
```
    已过时。
  - getMaxBlockTime
```
public long getMaxBlockTime()
```
    已过时。
  - setMaxBlockTime
```
public void setMaxBlockTime(long t)
```
    已过时。
  - setMaxBlockTimes
```
public void setMaxBlockTimes(java.lang.String str)
```
    已过时。
  - getMaxBlockTimes
```
public java.lang.String getMaxBlockTimes()
```
    已过时。
  - getTotalTimeBlocked
```
public long getTotalTimeBlocked()
```
    已过时。
  - getAverageTimeBlocked
```
public double getAverageTimeBlocked()
```
    已过时。
  - getNumberOfCreditRequestsReceived
```
public int getNumberOfCreditRequestsReceived()
```
    已过时。
  - getNumberOfCreditRequestsSent
```
public int getNumberOfCreditRequestsSent()
```
    已过时。
  - getNumberOfCreditResponsesReceived
```
public int getNumberOfCreditResponsesReceived()
```
    已过时。
  - getNumberOfCreditResponsesSent
```
public int getNumberOfCreditResponsesSent()
```
    已过时。
  - printSenderCredits
```
public java.lang.String printSenderCredits()
```
    已过时。
  - printReceiverCredits
```
public java.lang.String printReceiverCredits()
```
    已过时。
  - printCredits
```
public java.lang.String printCredits()
```
    已过时。
  - printCreditors
```
public java.lang.String printCreditors()
```
    已过时。
  - dumpStats
```
public java.util.Map<java.lang.String,java.lang.Object> dumpStats()
```
    已过时。
    
    覆盖:
    
    dumpStats 在类中 Protocol
  - showLastBlockingTimes
```
public java.lang.String showLastBlockingTimes()
```
    已过时。
  - unblock
```
public void unblock()
```
    已过时。
    
    Allows to unblock a blocked sender from an external program, e.g. JMX
  - init
```
public void init()
          throws java.lang.Exception
```
    已过时。
    
    从类复制的说明: Protocol
    
    Called after instance has been created (null constructor) and before protocol is started. Properties are already set. Other protocols are not yet connected and events cannot yet be sent.
    
    覆盖:
    
    init 在类中 Protocol
    
    抛出:
    
    java.lang.Exception - Thrown if protocol cannot be initialized successfully. This will cause the ProtocolStack to fail, so the channel constructor will throw an exception
  - start
```
public void start()
           throws java.lang.Exception
```
    已过时。
    
    从类复制的说明: Protocol
    
    This method is called on a Channel.connect(String). Starts work. Protocols are connected and queues are ready to receive events. Will be called from bottom to top. This call will replace the START and START_OK events.
    
    覆盖:
    
    start 在类中 Protocol
    
    抛出:
    
    java.lang.Exception - Thrown if protocol cannot be started successfully. This will cause the ProtocolStack to fail, so Channel.connect(String) will throw an exception
  - stop
```
public void stop()
```
    已过时。
    
    从类复制的说明: Protocol
    
    This method is called on a Channel.disconnect(). Stops work (e.g. by closing multicast socket). Will be called from top to bottom. This means that at the time of the method invocation the neighbor protocol below is still working. This method will replace the STOP, STOP_OK, CLEANUP and CLEANUP_OK events. The ProtocolStack guarantees that when this method is called all messages in the down queue will have been flushed
    
    覆盖:
    
    stop 在类中 Protocol
  - down
```
public java.lang.Object down(Event evt)
```
    已过时。
    
    从类复制的说明: Protocol
    
    An event is to be sent down the stack. The layer may want to examine its type and perform some action on it, depending on the event's type. If the event is a message MSG, then the layer may need to add a header to it (or do nothing at all) before sending it down the stack using down_prot.down(). In case of a GET_ADDRESS event (which tries to retrieve the stack's address from one of the bottom layers), the layer may need to send a new response event back up the stack using up_prot.up().
    
    覆盖:
    
    down 在类中 Protocol
  - up
```
public java.lang.Object up(Event evt)
```
    已过时。
    
    从类复制的说明: Protocol
    
    An event was received from the layer below. Usually the current layer will want to examine the event type and - depending on its type - perform some computation (e.g. removing headers from a MSG event type, or updating the internal membership list when receiving a VIEW_CHANGE event). Finally the event is either a) discarded, or b) an event is sent down the stack using down_prot.down() or c) the event (or another event) is sent up the stack using up_prot.up().
    
    覆盖:
    
    up 在类中 Protocol
  - up
```
public void up(MessageBatch batch)
```
    已过时。
    
    从类复制的说明: Protocol
    
    Sends up a multiple messages in a MessageBatch. The sender of the batch is always the same, and so is the destination (null == multicast messages). Messages in a batch can be OOB messages, regular messages, or mixed messages, although the transport itself will create initial MessageBatches that contain only either OOB or regular messages.
    The default processing below sends messages up the stack individually, based on a matching criteria (calling Protocol.accept(Message)), and - if true - calls Protocol.up(Event) for that message and removes the message. If the batch is not empty, it is passed up, or else it is dropped.
    Subclasses should check if there are any messages destined for them (e.g. using MessageBatch.getMatchingMessages(short, boolean)), then possibly remove and process them and finally pass the batch up to the next protocol. Protocols can also modify messages in place, e.g. ENCRYPT could decrypt all encrypted messages in the batch, not remove them, and pass the batch up when done.
    
    覆盖:
    
    up 在类中 Protocol
    
    参数:
    batch - The message batch
  - handleUpEvent
```
protected void handleUpEvent(FcHeader hdr,
                 Message msg)
```
    已过时。

类 FC

字段概要

从类继承的字段 com.fr.third.jgroups.stack.Protocol

构造器概要

方法概要

从类继承的方法 com.fr.third.jgroups.stack.Protocol

从类继承的方法 java.lang.Object

构造器详细资料

FC

方法详细资料

resetStats

getMaxCredits

setMaxCredits

getMinThreshold

setMinThreshold

getMinCredits

setMinCredits

getNumberOfBlockings

getMaxBlockTime

setMaxBlockTime

setMaxBlockTimes

getMaxBlockTimes

getTotalTimeBlocked

getAverageTimeBlocked

getNumberOfCreditRequestsReceived

getNumberOfCreditRequestsSent

getNumberOfCreditResponsesReceived

getNumberOfCreditResponsesSent

printSenderCredits

printReceiverCredits

printCredits

printCreditors

dumpStats

showLastBlockingTimes

unblock

init

start

stop

down

up

up

handleUpEvent