====== STUN Layer (stun) ======

This layer provides //[[https://datatracker.ietf.org/doc/html/rfc5389|RFC5389: Session Traversal Utilities for NAT (STUN)]]// support. It can be placed on top of UDP layers.


===== STUN Layer Configuration Parameters =====

^                          Parameter^      Type^                                                           Description^
|                              Alias|    String|                                                                      |
|                    Debug Log Level|    Number|                                                           Debug Level|
|                       Dependencies|    String|                                    Other dependencies to this element|
|                   Destination Peer|    Number|                                                                      |
|                    Diff L3 L4 STUN|    Number|                                           Different L3 and L4 Address|
|                       Diff L3 STUN|    Number|                                                  Different L3 Address|
|                       Diff L4 STUN|    Number|                                                  Different L4 Address|
|                       Event Filter|    String|                                                       Filter of Event|
|                        Exact Match|   Boolean|                                                                      |
|               Max Event Queue Size|    Number|                                                    Maximum Queue Size|
|                               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|                                                                      |
|                      STUN2 Support|   Boolean|                                                         Support STUN2|
|                Save Dynamic Config|   Boolean|                                                                      |
|                     Server L3 Addr|    String|                                                  L3 Address of Server|
|                     Server L4 Addr|    String|                                                  L4 Address of Server|
|                      Show Commands|   Boolean|                                                         Show Commands|
|                        Show Events|   Boolean|                                                           Show Events|
|                              Watch|   Boolean|                                                           Watch Layer|

===== STUN Layer Real-Time Parameters =====

^                          Parameter^      Type^                                                           Description^
|               Allow Blocking Event|   Boolean|                                                       Blocking Events|
|                            Blocked|   Boolean|                                                     Disable Component|
|                    Debug Log Level|    Number|                                                           Debug Level|
|                        Passthrough|   Boolean|                                         High-to-Low Layer Passthrough|
|                      STUN2 Support|   Boolean|                                                         Support STUN2|
|                              Watch|   Boolean|                                                           Watch Layer|

===== STUN Layer Functions =====

^                                                    Function^      Type^                                                           Description^
|                       getStatsStunAvailableInstances(layer)|    getter|                                   Get "Available Instances" Parameter|
|                     getStatsStunDownstreamLastPacket(layer)|    getter|                                Get "Downstream Last Packet" Parameter|
|                    getStatsStunDownstreamPacketCount(layer)|    getter|                               Get "Downstream Packet Count" Parameter|
|                       getStatsStunMaxDownstreamDelay(layer)|    getter|                                  Get "Max Downstream Delay" Parameter|
|                         getStatsStunMaxUpstreamDelay(layer)|    getter|                                    Get "Max Upstream Delay" Parameter|
|                      getStatsStunMeanDownstreamDelay(layer)|    getter|                                 Get "Mean Downstream Delay" Parameter|
|                        getStatsStunMeanUpstreamDelay(layer)|    getter|                                   Get "Mean Upstream Delay" Parameter|
|                       getStatsStunMinDownstreamDelay(layer)|    getter|                                  Get "Min Downstream Delay" Parameter|
|                         getStatsStunMinUpstreamDelay(layer)|    getter|                                    Get "Min Upstream Delay" Parameter|
|                                     getStatsStunName(layer)|    getter|                                                  Get "Name" Parameter|
|                        getStatsStunRateBpsDownstream(layer)|    getter|                                   Get "Rate Bps Downstream" Parameter|
|                          getStatsStunRateBpsUpstream(layer)|    getter|                                     Get "Rate Bps Upstream" Parameter|
|                              getStatsStunTimestampIn(layer)|    getter|                                          Get "Timestamp In" Parameter|
|                             getStatsStunTimestampOut(layer)|    getter|                                         Get "Timestamp Out" Parameter|
|                                     getStatsStunType(layer)|    getter|                                                  Get "Type" Parameter|
|                       getStatsStunUpstreamLastPacket(layer)|    getter|                                  Get "Upstream Last Packet" Parameter|
|                      getStatsStunUpstreamPacketCount(layer)|    getter|                                 Get "Upstream Packet Count" Parameter|
|                  getStatsStunVarianceDownstreamDelay(layer)|    getter|                             Get "Variance Downstream Delay" Parameter|
|                    getStatsStunVarianceUpstreamDelay(layer)|    getter|                               Get "Variance Upstream Delay" Parameter|
|                            getStunAllowBlockingEvent(layer)|    getter|                                  Get "Allow Blocking Event" Parameter|
|                                       getStunBlocked(layer)|    getter|                                               Get "Blocked" Parameter|
|                                 getStunDebugLogLevel(layer)|    getter|                                       Get "Debug Log Level" Parameter|
|                               getStunDestinationPeer(layer)|    getter|                                      Get "Destination Peer" Parameter|
|                                      getStunNoEvents(layer)|    getter|                                             Get "No Events" Parameter|
|                                   getStunPassthrough(layer)|    getter|                                           Get "Passthrough" Parameter|
|                                  getStunSTUN2Support(layer)|    getter|                                         Get "STUN2 Support" Parameter|
|                                         getStunWatch(layer)|    getter|                                                 Get "Watch" Parameter|
|                      setStunAllowBlockingEvent(layer,value)|    setter|                                  Set "Allow Blocking Event" Parameter|
|                                 setStunBlocked(layer,value)|    setter|                                               Set "Blocked" Parameter|
|                           setStunDebugLogLevel(layer,value)|    setter|                                       Set "Debug Log Level" Parameter|
|                                setStunNoEvents(layer,value)|    setter|                                             Set "No Events" Parameter|
|                             setStunPassthrough(layer,value)|    setter|                                           Set "Passthrough" Parameter|
|                            setStunSTUN2Support(layer,value)|    setter|                                         Set "STUN2 Support" Parameter|
|                                   setStunWatch(layer,value)|    setter|                                                 Set "Watch" Parameter|