====== TCP Layer (tcp) ======

This layer provides Transport Control Protocol support. It can be placed on top of IP layers.

===== TCP Layer Configuration Parameters =====

^                          Parameter^      Type^                                                           Description^
|                              Alias|    String|                                                                      |
|                    Connect Address|    Number|                                                 Address to Connect to|
|                       Connect Port|    Number|                                                    Port to Connect to|
|                    Debug Log Level|    Number|                                                           Debug Level|
|                       Dependencies|    String|                                    Other dependencies to this element|
|                          Dest Port|    Number|                                                                      |
|                   Destination Peer|    Number|                                                                      |
|                       Event Filter|    String|                                                       Filter of Event|
|                        Exact Match|   Boolean|                                                                      |
|                             Listen|   Boolean|                                                                      |
|               Max Event Queue Size|    Number|                                                    Maximum Queue Size|
|                               Name|    String|                                                        Component Name|
|                          No Events|   Boolean|                                                                      |
|                    No L2 Addresses|   Boolean|                                           Force Hardware L2 Addresses|
|                        Passthrough|   Boolean|                                         High-to-Low Layer Passthrough|
|                               Port|    Number|                                                          TCP/UDP Port|
|                 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|

===== TCP Layer Real-Time Parameters =====

^                          Parameter^      Type^                                                           Description^
|               Allow Blocking Event|   Boolean|                                                       Blocking Events|
|                            Blocked|   Boolean|                                                     Disable Component|
|                    Debug Log Level|    Number|                                                           Debug Level|
|                    No L2 Addresses|   Boolean|                                           Force Hardware L2 Addresses|
|                       OS Transport|   Boolean|                                           Force OS based L2/L3 Layers|
|                        Passthrough|   Boolean|                                         High-to-Low Layer Passthrough|
|                               Port|    Number|                                                          TCP/UDP Port|
|                              Watch|   Boolean|                                                           Watch Layer|

===== TCP Layer Functions =====

^                                                    Function^      Type^                                                           Description^
|                        getStatsTcpAvailableInstances(layer)|    getter|                                   Get "Available Instances" Parameter|
|                               getStatsTcpConnections(layer)|    getter|                                           Get "Connections" Parameter|
|                      getStatsTcpDownstreamLastPacket(layer)|    getter|                                Get "Downstream Last Packet" Parameter|
|                     getStatsTcpDownstreamPacketCount(layer)|    getter|                               Get "Downstream Packet Count" Parameter|
|                        getStatsTcpMaxDownstreamDelay(layer)|    getter|                                  Get "Max Downstream Delay" Parameter|
|                          getStatsTcpMaxUpstreamDelay(layer)|    getter|                                    Get "Max Upstream Delay" Parameter|
|                       getStatsTcpMeanDownstreamDelay(layer)|    getter|                                 Get "Mean Downstream Delay" Parameter|
|                         getStatsTcpMeanUpstreamDelay(layer)|    getter|                                   Get "Mean Upstream Delay" Parameter|
|                        getStatsTcpMinDownstreamDelay(layer)|    getter|                                  Get "Min Downstream Delay" Parameter|
|                          getStatsTcpMinUpstreamDelay(layer)|    getter|                                    Get "Min Upstream Delay" Parameter|
|                                      getStatsTcpName(layer)|    getter|                                                  Get "Name" Parameter|
|                         getStatsTcpRateBpsDownstream(layer)|    getter|                                   Get "Rate Bps Downstream" Parameter|
|                           getStatsTcpRateBpsUpstream(layer)|    getter|                                     Get "Rate Bps Upstream" Parameter|
|                                     getStatsTcpState(layer)|    getter|                                                 Get "State" Parameter|
|                               getStatsTcpTimestampIn(layer)|    getter|                                          Get "Timestamp In" Parameter|
|                              getStatsTcpTimestampOut(layer)|    getter|                                         Get "Timestamp Out" Parameter|
|                                      getStatsTcpType(layer)|    getter|                                                  Get "Type" Parameter|
|                        getStatsTcpUpstreamLastPacket(layer)|    getter|                                  Get "Upstream Last Packet" Parameter|
|                       getStatsTcpUpstreamPacketCount(layer)|    getter|                                 Get "Upstream Packet Count" Parameter|
|                   getStatsTcpVarianceDownstreamDelay(layer)|    getter|                             Get "Variance Downstream Delay" Parameter|
|                     getStatsTcpVarianceUpstreamDelay(layer)|    getter|                               Get "Variance Upstream Delay" Parameter|
|                             getTcpAllowBlockingEvent(layer)|    getter|                                  Get "Allow Blocking Event" Parameter|
|                                        getTcpBlocked(layer)|    getter|                                               Get "Blocked" Parameter|
|                                  getTcpDebugLogLevel(layer)|    getter|                                       Get "Debug Log Level" Parameter|
|                                       getTcpDestPort(layer)|    getter|                                             Get "Dest Port" Parameter|
|                                getTcpDestinationPeer(layer)|    getter|                                      Get "Destination Peer" Parameter|
|                                       getTcpNoEvents(layer)|    getter|                                             Get "No Events" Parameter|
|                                  getTcpNoL2Addresses(layer)|    getter|                                       Get "No L2 Addresses" Parameter|
|                                    getTcpOSTransport(layer)|    getter|                                          Get "OS Transport" Parameter|
|                                    getTcpPassthrough(layer)|    getter|                                           Get "Passthrough" Parameter|
|                                           getTcpPort(layer)|    getter|                                                  Get "Port" Parameter|
|                                          getTcpWatch(layer)|    getter|                                                 Get "Watch" Parameter|
|                                  isEventTcpConnected(event)|     event|                                          Connection Established Event|
|                                 isEventTcpTerminated(event)|     event|                                           Connection Terminated Event|
|                       setTcpAllowBlockingEvent(layer,value)|    setter|                                  Set "Allow Blocking Event" Parameter|
|                                  setTcpBlocked(layer,value)|    setter|                                               Set "Blocked" Parameter|
|                            setTcpDebugLogLevel(layer,value)|    setter|                                       Set "Debug Log Level" Parameter|
|                                 setTcpDestPort(layer,value)|    setter|                                             Set "Dest Port" Parameter|
|                                 setTcpNoEvents(layer,value)|    setter|                                             Set "No Events" Parameter|
|                              setTcpPassthrough(layer,value)|    setter|                                           Set "Passthrough" Parameter|
|                                    setTcpWatch(layer,value)|    setter|                                                 Set "Watch" Parameter|
|                                             tcpClose(layer)|  function|                                                      Close Connection|
|                                   tcpConnect(layer,address)|  function|                                                               Connect|
|                                            tcpListen(layer)|  function|                                                Listen for Connections|