====== Channel Capacity Layer (capacity) ======

The channel capacity layer can be used to limit throughput. This layer can be placed on top of any other layer.

===== Channel Capacity Layer Configuration Parameters =====

^                          Parameter^      Type^                                                           Description^
|                              Alias|    String|                                                                      |
|                   Apply Downstream|   Boolean|                                      Apply parameters to Lower Layers|
|                     Apply Upstream|   Boolean|                                      Apply parameters to Upper Layers|
|                    Debug Log Level|    Number|                                                           Debug Level|
|                       Dependencies|    String|                                    Other dependencies to this element|
|                   Destination Peer|    Number|                                                                      |
|                       Event Filter|    String|                                                       Filter of Event|
|                        Exact Match|   Boolean|                                                                      |
|               Max Event Queue Size|    Number|                                                    Maximum Queue Size|
|            Max Rate Bps Downstream|    Number|                                      Maximum Downstream BitRate (bps)|
|              Max Rate Bps Upstream|    Number|                                        Maximum Upstream BitRate (bps)|
|                               Name|    String|                                                        Component Name|
|                          No Events|   Boolean|                                                                      |
|                        Passthrough|   Boolean|                                         High-to-Low Layer Passthrough|
|                 Raw Data To Inject|    String|                                                 Data Packet to Inject|
|               Raw Dst L2 To Inject|    String|                                                Destination L2 Address|
|               Raw Dst L3 To Inject|    String|                                                Destination L3 Address|
|               Raw Dst L4 To Inject|    String|                                                Destination L4 Address|
|                    Request Timeout|    Number|                                                                      |
|                Save Dynamic Config|   Boolean|                                                                      |
|                      Show Commands|   Boolean|                                                         Show Commands|
|                        Show Events|   Boolean|                                                           Show Events|
|                              Watch|   Boolean|                                                           Watch Layer|

===== Channel Capacity Layer Real-Time Parameters =====

^                          Parameter^      Type^                                                           Description^
|               Allow Blocking Event|   Boolean|                                                       Blocking Events|
|                   Apply Downstream|   Boolean|                                      Apply parameters to Lower Layers|
|                     Apply Upstream|   Boolean|                                      Apply parameters to Upper Layers|
|                            Blocked|   Boolean|                                                     Disable Component|
|                    Debug Log Level|    Number|                                                           Debug Level|
|                      Max Instances|    Number|                            Maximum Number of Instances of a Component|
|            Max Rate Bps Downstream|    Number|                                      Maximum Downstream BitRate (bps)|
|              Max Rate Bps Upstream|    Number|                                        Maximum Upstream BitRate (bps)|
|                        Passthrough|   Boolean|                                         High-to-Low Layer Passthrough|
|                              Watch|   Boolean|                                                           Watch Layer|

===== Channel Capacity Layer Functions =====

^                                                    Function^      Type^                                                           Description^
|                        getCapacityAllowBlockingEvent(layer)|    getter|                                  Get "Allow Blocking Event" Parameter|
|                           getCapacityApplyDownstream(layer)|    getter|                                      Get "Apply Downstream" Parameter|
|                             getCapacityApplyUpstream(layer)|    getter|                                        Get "Apply Upstream" Parameter|
|                                   getCapacityBlocked(layer)|    getter|                                               Get "Blocked" Parameter|
|                             getCapacityDebugLogLevel(layer)|    getter|                                       Get "Debug Log Level" Parameter|
|                           getCapacityDestinationPeer(layer)|    getter|                                      Get "Destination Peer" Parameter|
|                              getCapacityMaxInstances(layer)|    getter|                                         Get "Max Instances" Parameter|
|                      getCapacityMaxRateBpsDownstream(layer)|    getter|                               Get "Max Rate Bps Downstream" Parameter|
|                        getCapacityMaxRateBpsUpstream(layer)|    getter|                                 Get "Max Rate Bps Upstream" Parameter|
|                                  getCapacityNoEvents(layer)|    getter|                                             Get "No Events" Parameter|
|                               getCapacityPassthrough(layer)|    getter|                                           Get "Passthrough" Parameter|
|                                     getCapacityWatch(layer)|    getter|                                                 Get "Watch" Parameter|
|                   getStatsCapacityAvailableInstances(layer)|    getter|                                   Get "Available Instances" Parameter|
|                 getStatsCapacityDownstreamLastPacket(layer)|    getter|                                Get "Downstream Last Packet" Parameter|
|                getStatsCapacityDownstreamPacketCount(layer)|    getter|                               Get "Downstream Packet Count" Parameter|
|                getStatsCapacityLostPacketsDownstream(layer)|    getter|                               Get "Lost Packets Downstream" Parameter|
|                  getStatsCapacityLostPacketsUpstream(layer)|    getter|                                 Get "Lost Packets Upstream" Parameter|
|                   getStatsCapacityMaxDownstreamDelay(layer)|    getter|                                  Get "Max Downstream Delay" Parameter|
|                     getStatsCapacityMaxUpstreamDelay(layer)|    getter|                                    Get "Max Upstream Delay" Parameter|
|                  getStatsCapacityMeanDownstreamDelay(layer)|    getter|                                 Get "Mean Downstream Delay" Parameter|
|                    getStatsCapacityMeanUpstreamDelay(layer)|    getter|                                   Get "Mean Upstream Delay" Parameter|
|                   getStatsCapacityMinDownstreamDelay(layer)|    getter|                                  Get "Min Downstream Delay" Parameter|
|                     getStatsCapacityMinUpstreamDelay(layer)|    getter|                                    Get "Min Upstream Delay" Parameter|
|                                 getStatsCapacityName(layer)|    getter|                                                  Get "Name" Parameter|
|                    getStatsCapacityRateBpsDownstream(layer)|    getter|                                   Get "Rate Bps Downstream" Parameter|
|                      getStatsCapacityRateBpsUpstream(layer)|    getter|                                     Get "Rate Bps Upstream" Parameter|
|                          getStatsCapacityTimestampIn(layer)|    getter|                                          Get "Timestamp In" Parameter|
|                         getStatsCapacityTimestampOut(layer)|    getter|                                         Get "Timestamp Out" Parameter|
|                                 getStatsCapacityType(layer)|    getter|                                                  Get "Type" Parameter|
|                   getStatsCapacityUpstreamLastPacket(layer)|    getter|                                  Get "Upstream Last Packet" Parameter|
|                  getStatsCapacityUpstreamPacketCount(layer)|    getter|                                 Get "Upstream Packet Count" Parameter|
|              getStatsCapacityVarianceDownstreamDelay(layer)|    getter|                             Get "Variance Downstream Delay" Parameter|
|                getStatsCapacityVarianceUpstreamDelay(layer)|    getter|                               Get "Variance Upstream Delay" Parameter|
|                  setCapacityAllowBlockingEvent(layer,value)|    setter|                                  Set "Allow Blocking Event" Parameter|
|                     setCapacityApplyDownstream(layer,value)|    setter|                                      Set "Apply Downstream" Parameter|
|                       setCapacityApplyUpstream(layer,value)|    setter|                                        Set "Apply Upstream" Parameter|
|                             setCapacityBlocked(layer,value)|    setter|                                               Set "Blocked" Parameter|
|                       setCapacityDebugLogLevel(layer,value)|    setter|                                       Set "Debug Log Level" Parameter|
|                setCapacityMaxRateBpsDownstream(layer,value)|    setter|                               Set "Max Rate Bps Downstream" Parameter|
|                  setCapacityMaxRateBpsUpstream(layer,value)|    setter|                                 Set "Max Rate Bps Upstream" Parameter|
|                            setCapacityNoEvents(layer,value)|    setter|                                             Set "No Events" Parameter|
|                         setCapacityPassthrough(layer,value)|    setter|                                           Set "Passthrough" Parameter|
|                               setCapacityWatch(layer,value)|    setter|                                                 Set "Watch" Parameter|