====== DHCP Layer (dhcp) ======

The DHCP layer provides DHCP server functionality. DHCP is specified in //[[https://datatracker.ietf.org/doc/html/rfc2131|RFC2131: Dynamic Host Configuration Protocol]]//. It can be placed on top of a UDP layer.

===== DHCP Layer Configuration Parameters =====

^                          Parameter^      Type^                                                           Description^
|                            Address|    String|                                            Ethernet/IPv4/IPv6 Address|
|                              Alias|    String|                                                                      |
|                                DNS|    String|                                                            Enable DNS|
|                    Debug Log Level|    Number|                                                           Debug Level|
|                       Dependencies|    String|                                    Other dependencies to this element|
|                   Destination Peer|    Number|                                                                      |
|                        Domain Name|    String|                                                           Domain Name|
|                       Event Filter|    String|                                                       Filter of Event|
|                        Exact Match|   Boolean|                                                                      |
|                              Lease|    Number|                                                                      |
|               Max Event Queue Size|    Number|                                                    Maximum Queue Size|
|                               Name|    String|                                                        Component Name|
|                            Netmask|    String|                                                            IP Netmask|
|             New Address On Renewal|   Boolean|                                                                      |
|                          No Events|   Boolean|                                                                      |
|                        Passthrough|   Boolean|                                         High-to-Low Layer Passthrough|
|                              Range|    String|                                                         Address Range|
|                 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|
|                             Rebind|    Number|                                                                      |
|                            Renewal|    Number|                                                                      |
|                    Request Timeout|    Number|                                                                      |
|                Save Dynamic Config|   Boolean|                                                                      |
|                      Show Commands|   Boolean|                                                         Show Commands|
|                        Show Events|   Boolean|                                                           Show Events|
|                              Watch|   Boolean|                                                           Watch Layer|

===== DHCP 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|
|                              Watch|   Boolean|                                                           Watch Layer|

===== DHCP Layer Functions =====

^                                                    Function^      Type^                                                           Description^
|                            getDhcpAllowBlockingEvent(layer)|    getter|                                  Get "Allow Blocking Event" Parameter|
|                                       getDhcpBlocked(layer)|    getter|                                               Get "Blocked" Parameter|
|                                 getDhcpDebugLogLevel(layer)|    getter|                                       Get "Debug Log Level" Parameter|
|                               getDhcpDestinationPeer(layer)|    getter|                                      Get "Destination Peer" Parameter|
|                                      getDhcpNoEvents(layer)|    getter|                                             Get "No Events" Parameter|
|                                   getDhcpPassthrough(layer)|    getter|                                           Get "Passthrough" Parameter|
|                                         getDhcpWatch(layer)|    getter|                                                 Get "Watch" Parameter|
|                       getStatsDhcpAvailableInstances(layer)|    getter|                                   Get "Available Instances" Parameter|
|                     getStatsDhcpDownstreamLastPacket(layer)|    getter|                                Get "Downstream Last Packet" Parameter|
|                    getStatsDhcpDownstreamPacketCount(layer)|    getter|                               Get "Downstream Packet Count" Parameter|
|                       getStatsDhcpMaxDownstreamDelay(layer)|    getter|                                  Get "Max Downstream Delay" Parameter|
|                         getStatsDhcpMaxUpstreamDelay(layer)|    getter|                                    Get "Max Upstream Delay" Parameter|
|                      getStatsDhcpMeanDownstreamDelay(layer)|    getter|                                 Get "Mean Downstream Delay" Parameter|
|                        getStatsDhcpMeanUpstreamDelay(layer)|    getter|                                   Get "Mean Upstream Delay" Parameter|
|                       getStatsDhcpMinDownstreamDelay(layer)|    getter|                                  Get "Min Downstream Delay" Parameter|
|                         getStatsDhcpMinUpstreamDelay(layer)|    getter|                                    Get "Min Upstream Delay" Parameter|
|                                     getStatsDhcpName(layer)|    getter|                                                  Get "Name" Parameter|
|                        getStatsDhcpRateBpsDownstream(layer)|    getter|                                   Get "Rate Bps Downstream" Parameter|
|                          getStatsDhcpRateBpsUpstream(layer)|    getter|                                     Get "Rate Bps Upstream" Parameter|
|                              getStatsDhcpTimestampIn(layer)|    getter|                                          Get "Timestamp In" Parameter|
|                             getStatsDhcpTimestampOut(layer)|    getter|                                         Get "Timestamp Out" Parameter|
|                                     getStatsDhcpType(layer)|    getter|                                                  Get "Type" Parameter|
|                       getStatsDhcpUpstreamLastPacket(layer)|    getter|                                  Get "Upstream Last Packet" Parameter|
|                      getStatsDhcpUpstreamPacketCount(layer)|    getter|                                 Get "Upstream Packet Count" Parameter|
|                  getStatsDhcpVarianceDownstreamDelay(layer)|    getter|                             Get "Variance Downstream Delay" Parameter|
|                    getStatsDhcpVarianceUpstreamDelay(layer)|    getter|                               Get "Variance Upstream Delay" Parameter|
|                      setDhcpAllowBlockingEvent(layer,value)|    setter|                                  Set "Allow Blocking Event" Parameter|
|                                 setDhcpBlocked(layer,value)|    setter|                                               Set "Blocked" Parameter|
|                           setDhcpDebugLogLevel(layer,value)|    setter|                                       Set "Debug Log Level" Parameter|
|                                setDhcpNoEvents(layer,value)|    setter|                                             Set "No Events" Parameter|
|                             setDhcpPassthrough(layer,value)|    setter|                                           Set "Passthrough" Parameter|
|                                   setDhcpWatch(layer,value)|    setter|                                                 Set "Watch" Parameter|