GoSNMPServer

https://pkg.go.dev/github.com/slayercat/GoSNMPServer
Admin
GoSNMPServer is a fully featured SNMP server library written in Go that supports SNMPv2c and SNMPv3...
Tokens:16,991
Snippets:228
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install and Run GoSNMPServer

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Installs the GoSNMPServer command-line tool and demonstrates how to run it. It also shows an example of using snmpwalk to interact with the running server.

```bash
go install github.com/slayercat/GoSNMPServer/cmd/gosnmpserver
$(go env GOPATH)/bin/gosnmpserver run-server
snmpwalk -v 3 -l authPriv  -n public -u testuser   -a md5 -A testauth -x des -X testpriv 127.0.0.1:1161 1

```

--------------------------------

### Configure and Start GoSNMPServer

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Sets up a master SNMP agent with security configurations and sub-agents, then starts the server listening on UDP.

```go
master := GoSNMPServer.MasterAgent{
    Logger: GoSNMPServer.NewDefaultLogger(),
    SecurityConfig: GoSNMPServer.SecurityConfig{
        AuthoritativeEngineBoots: 1,
        Users: []gosnmp.UsmSecurityParameters{
            {
                UserName:                 c.String("v3Username"),
                AuthenticationProtocol:   gosnmp.MD5,
                PrivacyProtocol:          gosnmp.DES,
                AuthenticationPassphrase: c.String("v3AuthenticationPassphrase"),
                PrivacyPassphrase:        c.String("v3PrivacyPassphrase"),
            },
        },
    },
    SubAgents: []*GoSNMPServer.SubAgent{
        {
            CommunityIDs: []string{c.String("community")},
            OIDs:         mibImps.All(),
        },
    },
}
server := GoSNMPServer.NewSNMPServer(master)
err := server.ListenUDP("udp", "127.0.0.1:1161")
if err != nil {
    logger.Errorf("Error in listen: %+v", err)
}
server.ServeForever()

```

--------------------------------

### SetupLogger

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer/mibImps/dismanEventMib

SetupLogger Setups Logger for this mib.

```APIDOC
## SetupLogger

### Description
SetupLogger Setups Logger for this mib.

### Signature
```go
func SetupLogger(i GoSNMPServer.ILogger)
```
```

--------------------------------

### Setup UDPListener Logger

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Configures the logger for the UDP listener.

```go
func (udp *UDPListener) SetupLogger(i ILogger)
```

--------------------------------

### SNMPServer.ServeForever

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

ServeForever starts the SNMP server and continuously serves incoming requests.

```APIDOC
## SNMPServer.ServeForever

### Description
Starts the SNMP server and continuously serves incoming requests.

### Signature
```go
func (server *SNMPServer) ServeForever() error
```
```

--------------------------------

### MasterAgent ReadyForWork Method

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

ReadyForWork prepares the MasterAgent to start processing SNMP requests.

```go
func (t *MasterAgent) ReadyForWork() error
```

--------------------------------

### Define Custom OID for GoSNMPServer

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Example of defining a custom OID with a Get function to serve specific data, using `GoSNMPServer.Asn1IntegerWrap` for type handling.

```go
{
    OID:      fmt.Sprintf("1.3.6.1.2.1.2.2.1.1.%d", ifIndex),
    Type:     gosnmp.Integer,
    OnGet:    func() (value interface{}, err error) { return GoSNMPServer.Asn1IntegerWrap(ifIndex), nil },
    Document: "ifIndex",
},

```

--------------------------------

### Setup Logger for DISMAN-EVENT-MIB

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer/mibImps/dismanEventMib

The SetupLogger function is used to configure the logger for this MIB. It requires an implementation of the ILogger interface.

```go
func SetupLogger(i GoSNMPServer.ILogger)
```

--------------------------------

### MasterAgent.ReadyForWork

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

ReadyForWork signals that the MasterAgent is prepared to start processing network requests.

```APIDOC
## (*MasterAgent) ReadyForWork

### Description
Indicates that the MasterAgent has completed its initialization and is ready to begin handling SNMP requests.

### Signature
```
func (t *MasterAgent) ReadyForWork() error
```

### Returns
- **error**: An error if the agent is not ready for work, otherwise `nil`.
```

--------------------------------

### Serve SNMP Requests Indefinitely

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Starts the SNMPServer to continuously serve incoming SNMP requests.

```go
func (server *SNMPServer) ServeForever() error
```

--------------------------------

### FuncPDUControlGet

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

FuncPDUControlGet will be called when a GET operation is performed to retrieve a value.

```APIDOC
## FuncPDUControlGet

### Description
Callback function invoked to retrieve a value during a GET operation.

### Type Signature
```
type FuncPDUControlGet func() (value interface{}, err error)
```

### Returns
- **value** (interface{}): The retrieved value.
- **err** (error): An error if the retrieval fails.
```

--------------------------------

### SNMPServer.ListenUDP

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

ListenUDP starts listening for UDP packets on the specified address and protocol.

```APIDOC
## SNMPServer.ListenUDP

### Description
Starts listening for UDP packets on the specified address and protocol.

### Parameters
#### Path Parameters
- **l3proto** (string) - The Layer 3 protocol (e.g., "udp4", "udp6").
- **address** (string) - The network address to listen on (e.g., ":161").

### Signature
```go
func (server *SNMPServer) ListenUDP(l3proto, address string) error
```
```

--------------------------------

### Shutdown UDPReplyer

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

This method is used to shut down the UDPReplyer. It does not require any specific setup or imports beyond the UDPReplyer type itself.

```go
func (r *UDPReplyer) Shutdown(){
}
```

--------------------------------

### Get All DISMAN-EVENT-MIB OIDs

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer/mibImps/dismanEventMib

The All function provides a list of commonly used OIDs within the DISMAN-EVENT-MIB.

```go
func All() []*GoSNMPServer.PDUValueControlItem
```

--------------------------------

### Get System Load OIDs

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer/mibImps/ucdMib

Returns a list of OIDs related to system load. Refer to the net-snmp MIB documentation for details on DisplayString.

```go
func SystemLoadOIDs() []*GoSNMPServer.PDUValueControlItem
```

--------------------------------

### Get UDPListener Address

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Retrieves the network address the UDP listener is bound to.

```go
func (udp *UDPListener) Address() net.Addr
```

--------------------------------

### Get SNMPServer Address

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Retrieves the network address the SNMPServer is listening on.

```go
func (server *SNMPServer) Address() net.Addr
```

--------------------------------

### DefaultGetAuthoritativeEngineTime Function Signature

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Function signature for getting the default authoritative engine time.

```go
func DefaultGetAuthoritativeEngineTime() uint32
```

--------------------------------

### Get System Statistics OIDs

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer/mibImps/ucdMib

Returns a list of OIDs for system statistics, including memory operations. Refer to the net-snmp MIB documentation for details on DisplayString.

```go
func SystemStatsOIDs() []*GoSNMPServer.PDUValueControlItem
```

--------------------------------

### FuncPDUControlGet Type

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

FuncPDUControlGet is a function type that will be called to get a value. It returns the value and an error.

```go
type FuncPDUControlGet func() (value interface{}, err error)
```

--------------------------------

### PDUValueControlItem

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

PDUValueControlItem describes the action of get, set, or walk operations for a specific OID within the PDU tree.

```APIDOC
## PDUValueControlItem

### Description
Describes the action of get, set, or walk operations for a specific OID within the PDU tree.

### Fields
- **OID** (string) - The OID this PDUValue works with.
- **Type** (gosnmp.Asn1BER) - Defines the type of this OID.
- **NonWalkable** (bool) - Marks this OID as not walkable. It will not be returned in walk items but will be returned in direct gets. All write-only items will be NonWalkable.
- **OnCheckPermission** (FuncPDUControlCheckPermission) - Called on access to this OID. Set to nil to allow all access. Returns PermissionAllowanceAllowed for allowed access, otherwise PermissionAllowanceDenied.
- **OnGet** (FuncPDUControlGet) - Called on any GET or walk operation. Set to nil to mark as a write-only item.
- **OnSet** (FuncPDUControlSet) - Called on any Set operation. Set to nil to mark as a read-only item.
- **OnTrap** (FuncPDUControlTrap) - Called on TRAP.
- **Document** (string) - Documentation for this PDU Item (ignored by the program).
```

--------------------------------

### Get Disk Usage OIDs

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer/mibImps/ucdMib

Returns a list of OIDs related to disk usage. Optionally, filter by specific paths using NameOverride. Refer to the net-snmp MIB documentation for details on DisplayString.

```go
func DiskUsageOIDs(showTheseNameOnly ...NameOverride) []*GoSNMPServer.PDUValueControlItem
```

--------------------------------

### ISnmpServerListener Interface

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

ISnmpServerListener defines the interface for an SNMP server listener, including methods for logger setup, address retrieval, receiving SNMP packets, and shutdown.

```go
type ISnmpServerListener interface {
	SetupLogger(ILogger)
	Address() net.Addr
	NextSnmp() (snmpbytes []byte, replyer IReplyer, err error)
	Shutdown()
}
```

--------------------------------

### Get Memory OIDs

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer/mibImps/ucdMib

Retrieves a list of OIDs for memory operations. Refer to the net-snmp MIB documentation for details on DisplayString.

```go
func MemoryOIDs() []*GoSNMPServer.PDUValueControlItem
```

--------------------------------

### Get sysUptime OID from DISMAN-EVENT-MIB

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer/mibImps/dismanEventMib

The DismanEventOids function retrieves the sysUptime OID. Refer to the provided OID-info and net-snmp documentation for more details.

```go
func DismanEventOids() []*GoSNMPServer.PDUValueControlItem
```

--------------------------------

### Define PDUValueControlItem Structure

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Defines a PDUValueControlItem which describes the action of get, set, or walk operations on an OID within the PDU tree. It includes fields for OID, type, walkability, and callback functions for permission checks and data retrieval/modification.

```go
type PDUValueControlItem struct {
	// OID controls which OID does this PDUValue works
	OID string
	// Type defines which type this OID is.
	Type gosnmp.Asn1BER

	// NonWalkable marks this oid as not walkable. It **WILL NOT** returned in walk items. but do retuend
	//             in direct get.
	//             All write only item will be NonWalkable
	NonWalkable bool

	// OnCheckPermission will be called on access this OID. set to nil to allow all access.
	//     return PermissionAllowanceAllowed for allow this access.
	//            (otherwrise) PermissionAllowanceDenied for disable access.
	OnCheckPermission FuncPDUControlCheckPermission

	// OnGet will be called on any GET / walk option. set to nil for mark this as a write-only item
	OnGet FuncPDUControlGet
	// OnSet will be called on any Set option. set to nil for mark as a read-only item.
	OnSet FuncPDUControlSet
	// OnTrap will be called on TRAP.
	OnTrap FuncPDUControlTrap

	//Document for this PDU Item. ignored by the program.
	Document string
}
```

--------------------------------

### func SetupLogger(i GoSNMPServer.ILogger)

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer/mibImps

SetupLogger sets up the logger for all sub MIBs.

```APIDOC
## func SetupLogger

### Description
SetupLogger Setups Logger for All sub mibs.

### Signature
```go
func SetupLogger(i GoSNMPServer.ILogger)
```
```

--------------------------------

### UDPListener.SetupLogger

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

SetupLogger configures the logger for the UDPListener.

```APIDOC
## UDPListener.SetupLogger

### Description
Configures the logger for the UDPListener.

### Parameters
#### Path Parameters
- **i** (ILogger) - The logger instance to set.

### Signature
```go
func (udp *UDPListener) SetupLogger(i ILogger)
```
```

--------------------------------

### All

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer/mibImps/dismanEventMib

All function provides a list of common used OID in DISMAN-EVENT-MIB.

```APIDOC
## All

### Description
All function provides a list of common used OID in DISMAN-EVENT-MIB.

### Signature
```go
func All() []*GoSNMPServer.PDUValueControlItem
```
```

--------------------------------

### Sync MasterAgent Configuration

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Synchronizes the configuration of the MasterAgent.

```go
func (t *MasterAgent) SyncConfig() error
```

--------------------------------

### Import GoSNMPServer Packages

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Imports necessary packages for using GoSNMPServer, including the core library and MIB import utilities.

```go
import "github.com/gosnmp/gosnmp"
import "github.com/slayercat/GoSNMPServer"
import "github.com/slayercat/GoSNMPServer/mibImps"

```

--------------------------------

### SNMPServer Methods

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Provides methods for creating, configuring, and managing an SNMP server instance.

```APIDOC
## SNMPServer

### Methods

- **NewSNMPServer(master MasterAgent) *SNMPServer**
  - Description: Creates a new SNMPServer instance.
  - Parameters:
    - master (MasterAgent) - The master agent to use for the server.
  - Returns:
    - *SNMPServer - A pointer to the newly created SNMPServer.

- **(server *SNMPServer) Address() net.Addr**
  - Description: Returns the network address the SNMP server is listening on.
  - Returns:
    - net.Addr - The network address.

- **(server *SNMPServer) ListenUDP(l3proto, address string) error**
  - Description: Configures the server to listen for UDP requests on the specified address.
  - Parameters:
    - l3proto (string) - The Layer 3 protocol (e.g., "udp", "udp6").
    - address (string) - The network address to listen on (e.g., ":161").
  - Returns:
    - error - An error if the listener setup fails.

- **(server *SNMPServer) ServeForever() error**
  - Description: Starts the SNMP server and listens for incoming requests indefinitely.
  - Returns:
    - error - An error if the server fails to start or encounters a critical issue.

- **(server *SNMPServer) ServeNextRequest() (err error)**
  - Description: Processes a single incoming SNMP request.
  - Returns:
    - error - An error if processing the request fails.

- **(server *SNMPServer) Shutdown()**
  - Description: Shuts down the SNMP server gracefully.
```

--------------------------------

### All

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer/mibImps/ifMib

All function provides a list of common used OID in IF-MIB.

```APIDOC
## All

### Description
Provides a list of common used OID in IF-MIB.

### Signature
```go
func All() []*GoSNMPServer.PDUValueControlItem
```
```

--------------------------------

### Create New SNMPServer

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Creates a new SNMPServer instance, requiring a MasterAgent for its operation.

```go
func NewSNMPServer(master MasterAgent) *SNMPServer
```

--------------------------------

### Get Default Authoritative Engine ID

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Returns the default authoritative SNMP Engine ID.

```go
func DefaultAuthoritativeEngineID() SNMPEngineID
```

--------------------------------

### Print Log Message

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Wraps the trace functionality to print log messages.

```go
func (i *SnmpLoggerAdapter) Print(args ...interface{})
```

--------------------------------

### All()

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer/mibImps/ucdMib

All function provides a list of common used OID in UCD-MIB.

```APIDOC
## All

### Description
Provides a list of common OIDs in the UCD-MIB.

### Function Signature
```go
func All() []*GoSNMPServer.PDUValueControlItem
```
```

--------------------------------

### SystemLoadOIDs()

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer/mibImps/ucdMib

SystemLoadOIDs Returns a list of system load-related OIDs.

```APIDOC
## SystemLoadOIDs

### Description
Returns a list of OIDs related to system load.

### Function Signature
```go
func SystemLoadOIDs() []*GoSNMPServer.PDUValueControlItem
```

### See Also
- http://www.net-snmp.org/docs/mibs/ucdavis.html#DisplayString
```

--------------------------------

### Printf Log Message

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Wraps the trace functionality to print formatted log messages.

```go
func (i *SnmpLoggerAdapter) Printf(format string, args ...interface{})
```

--------------------------------

### Sync SubAgent Configuration

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Synchronizes the configuration of the SubAgent.

```go
func (t *SubAgent) SyncConfig() error
```

--------------------------------

### Get Network Data OIDs

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer/mibImps/ifMib

The NetworkOIDs function returns a list of network data OIDs. Refer to the net-snmp documentation for more details on these OIDs.

```go
func NetworkOIDs() []*GoSNMPServer.PDUValueControlItem
```

--------------------------------

### NameOverride Type Definition

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer/mibImps/ucdMib

Defines a configuration for disk usage OIDs. RealPath specifies the path on the PC, and ShowName determines how it appears in the OID (e.g., currentDskPath or currentDskDevice).

```go
type NameOverride struct {
	// RealPath in this pc.
	RealPath string

	// ShowName indicate what will it show in oid:
	//    in currentDskPath   1.3.6.1.4.1.2021.9.1.2.xxx
	//       currentDskDevice 1.3.6.1.4.1.2021.9.1.3.xxx
	ShowName string
}
```

--------------------------------

### NewSNMPServer

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

NewSNMPServer creates a new SNMPServer instance with the provided MasterAgent.

```APIDOC
## NewSNMPServer

### Description
Creates a new SNMPServer instance with the provided MasterAgent.

### Signature
```go
func NewSNMPServer(master MasterAgent) *SNMPServer
```
```

--------------------------------

### UDPListener Methods

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Provides methods for managing a UDP-based SNMP listener.

```APIDOC
## UDPListener

### Methods

- **NewUDPListener(l3proto, address string) (ISnmpServerListener, error)**
  - Description: Creates a new UDP listener.
  - Parameters:
    - l3proto (string) - The Layer 3 protocol (e.g., "udp", "udp6").
    - address (string) - The network address to listen on (e.g., ":161").
  - Returns:
    - ISnmpServerListener - The created UDP listener.
    - error - An error if listener creation fails.

- **(udp *UDPListener) Address() net.Addr**
  - Description: Returns the network address the listener is bound to.
  - Returns:
    - net.Addr - The network address.

- **(udp *UDPListener) NextSnmp() ([]byte, IReplyer, error)**
  - Description: Waits for and retrieves the next incoming SNMP packet and a replyer.
  - Returns:
    - []byte - The raw SNMP packet data.
    - IReplyer - An object to send a reply.
    - error - An error if receiving the packet fails.

- **(udp *UDPListener) SetupLogger(i ILogger)**
  - Description: Sets up a logger for the UDP listener.
  - Parameters:
    - i (ILogger) - The logger instance to use.

- **(udp *UDPListener) Shutdown()**
  - Description: Shuts down the UDP listener.
```

--------------------------------

### Serve Next SNMP Request

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Processes and serves the next incoming SNMP request.

```go
func (server *SNMPServer) ServeNextRequest() (err error)
```

--------------------------------

### UDPReplyer.ReplyPDU

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

ReplyPDU sends a PDU response back to the client.

```APIDOC
## UDPReplyer.ReplyPDU

### Description
Sends a PDU response back to the client.

### Parameters
#### Path Parameters
- **i** ([]byte) - The PDU data to send as a reply.

### Signature
```go
func (r *UDPReplyer) ReplyPDU(i []byte) error
```
```

--------------------------------

### func All() []*GoSNMPServer.PDUValueControlItem

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer/mibImps

The All function provides a list of commonly used OIDs, including parts of ucdMib, ifMib, and dismanEventMib.

```APIDOC
## func All

### Description
All function provides a list of common used OID.
includes part of ucdMib, ifMib, and dismanEventMib

### Signature
```go
func All() []*GoSNMPServer.PDUValueControlItem
```
```

--------------------------------

### Serve SNMP Packet with SubAgent

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Serves an incoming SNMP packet using the SubAgent's configuration and logic.

```go
func (t *SubAgent) Serve(i *gosnmp.SnmpPacket) (*gosnmp.SnmpPacket, error)
```

--------------------------------

### SNMPServer Structure

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Represents an SNMP server instance.

```go
type SNMPServer struct {
	// contains filtered or unexported fields
}
```

--------------------------------

### UDPReplyer

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

UDPReplyer is responsible for replying to SNMP requests over UDP.

```APIDOC
## UDPReplyer

### Description
Responsible for replying to SNMP requests over UDP.
```

--------------------------------

### MasterAgent.SyncConfig

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

SyncConfig synchronizes the configuration for the MasterAgent. It returns an error if the synchronization fails.

```APIDOC
## MasterAgent.SyncConfig

### Description
Synchronizes the configuration for the MasterAgent.

### Signature
```go
func (t *MasterAgent) SyncConfig() error
```
```

--------------------------------

### SecurityConfig Structure

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Configuration for SNMP security, including options for no security, SNMPv3 only, authoritative engine ID and boots, and user security parameters.

```go
type SecurityConfig struct {
	NoSecurity bool

	// SnmpV3Only is used for mark only snmpv3 is supported
	SnmpV3Only bool

	// AuthoritativeEngineID is SNMPV3 AuthoritativeEngineID
	AuthoritativeEngineID SNMPEngineID
	// AuthoritativeEngineBoots is SNMPV3 AuthoritativeEngineBoots
	AuthoritativeEngineBoots uint32
	// OnGetAuthoritativeEngineTime will be called to get SNMPV3 AuthoritativeEngineTime
	//      if sets to nil, the sys boottime will be used
	OnGetAuthoritativeEngineTime FuncGetAuthoritativeEngineTime

	Users []gosnmp.UsmSecurityParameters
}
```

--------------------------------

### NewUDPListener

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

NewUDPListener creates a new network listener for UDP connections.

```APIDOC
## NewUDPListener

### Description
Initializes and returns a new network listener that operates over UDP.

### Signature
```
func NewUDPListener(l3proto, address string) (ISnmpServerListener, error)
```

### Parameters
#### Arguments
- **l3proto** (string): The Layer 3 protocol to use (e.g., "udp", "udp6").
- **address** (string): The network address to bind to (e.g., ":161").

### Returns
- **ISnmpServerListener**: An interface for the SNMP server listener.
- **error**: An error if the listener could not be created.
```

--------------------------------

### NewUDPListener Function

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

NewUDPListener creates a new UDP listener for SNMP communication, specifying the L3 protocol and address.

```go
func NewUDPListener(l3proto, address string) (ISnmpServerListener, error)
```

--------------------------------

### SubAgent.SyncConfig

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

SyncConfig synchronizes the configuration for the SubAgent. It returns an error if the synchronization fails.

```APIDOC
## SubAgent.SyncConfig

### Description
Synchronizes the configuration for the SubAgent.

### Signature
```go
func (t *SubAgent) SyncConfig() error
```
```

--------------------------------

### UDPListener Structure

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Represents a UDP listener for receiving SNMP data.

```go
type UDPListener struct {
	// contains filtered or unexported fields
}
```

--------------------------------

### UDPReplyer Structure

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Represents a UDP replyer for sending SNMP responses.

```go
type UDPReplyer struct {
	// contains filtered or unexported fields
}
```

--------------------------------

### NewDefaultLogger

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

NewDefaultLogger creates and returns a new instance of the default logger.

```APIDOC
## NewDefaultLogger

### Description
Creates a new logger instance that implements the `ILogger` interface.

### Signature
```
func NewDefaultLogger() ILogger
```

### Returns
- **ILogger**: An instance of the default logger.
```

--------------------------------

### Asn1Uinteger32Wrap Function Signature

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Function signature for wrapping a uint32 value as ASN.1 Uinteger32.

```go
func Asn1Uinteger32Wrap(i uint32) interface{}
```

--------------------------------

### MasterAgent ResponseForPkt Method

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

ResponseForPkt processes an SNMP packet and returns the corresponding SNMP packet response, along with any potential error.

```go
func (t *MasterAgent) ResponseForPkt(i *gosnmp.SnmpPacket) (*gosnmp.SnmpPacket, error)
```

--------------------------------

### NewDefaultLogger Function

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

NewDefaultLogger creates and returns a new instance of the default logger, which implements the ILogger interface.

```go
func NewDefaultLogger() ILogger
```

--------------------------------

### SNMPServer.ServeNextRequest

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

ServeNextRequest serves the next incoming SNMP request.

```APIDOC
## SNMPServer.ServeNextRequest

### Description
Serves the next incoming SNMP request.

### Signature
```go
func (server *SNMPServer) ServeNextRequest() (err error)
```
```

--------------------------------

### Define ErrUnsupportedProtoVersion Variable

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Defines the error variable for unsupported protocol versions.

```go
var ErrUnsupportedProtoVersion = errors.New("ErrUnsupportedProtoVersion")
```

--------------------------------

### SystemStatsOIDs()

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer/mibImps/ucdMib

SystemStatsOIDs Returns a list of system statistics-related OIDs.

```APIDOC
## SystemStatsOIDs

### Description
Returns a list of OIDs related to system statistics.

### Function Signature
```go
func SystemStatsOIDs() []*GoSNMPServer.PDUValueControlItem
```

### See Also
- http://www.net-snmp.org/docs/mibs/ucdavis.html#DisplayString
```

--------------------------------

### SnmpLoggerAdapter.Printf

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Printf wraps the underlying logger's Printf method.

```APIDOC
## SnmpLoggerAdapter.Printf

### Description
Wraps the underlying logger's Printf method.

### Signature
```go
func (i *SnmpLoggerAdapter) Printf(format string, args ...interface{})
```
```

--------------------------------

### GenSalt Function Signature

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Function signature for generating a salt using UsmSecurityParameters.

```go
func GenSalt(sp *gosnmp.UsmSecurityParameters)
```

--------------------------------

### SnmpLoggerAdapter.Print

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Print wraps the underlying logger's Print method.

```APIDOC
## SnmpLoggerAdapter.Print

### Description
Wraps the underlying logger's Print method.

### Signature
```go
func (i *SnmpLoggerAdapter) Print(args ...interface{})
```
```

--------------------------------

### Asn1OpaqueDoubleWrap Function Signature

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Function signature for wrapping a float64 value as ASN.1 OpaqueDouble.

```go
func Asn1OpaqueDoubleWrap(i float64) interface{}
```

--------------------------------

### UDPListener

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

UDPListener is responsible for listening for and receiving UDP packets for SNMP.

```APIDOC
## UDPListener

### Description
Responsible for listening for and receiving UDP packets for SNMP.
```

--------------------------------

### Asn1Counter32Wrap Function Signature

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Function signature for wrapping a uint value as ASN.1 Counter32.

```go
func Asn1Counter32Wrap(i uint) interface{}
```

--------------------------------

### DiskUsageOIDs()

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer/mibImps/ucdMib

DiskUsageOIDs Returns a list of disk usages. It can be filtered by specific paths.

```APIDOC
## DiskUsageOIDs

### Description
Returns a list of disk usages. You can optionally specify which paths to retrieve.

### Function Signature
```go
func DiskUsageOIDs(showTheseNameOnly ...NameOverride) []*GoSNMPServer.PDUValueControlItem
```

### Parameters
#### Path Parameters
- **showTheseNameOnly** (*NameOverride) - Optional - Specifies the paths for which to retrieve disk usage information. If empty, all paths are returned.

### See Also
- http://www.net-snmp.org/docs/mibs/ucdavis.html#DisplayString
```

--------------------------------

### SubAgent.Serve

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Serve processes an incoming SNMP packet and returns a response packet or an error.

```APIDOC
## SubAgent.Serve

### Description
Processes an incoming SNMP packet and returns a response packet or an error.

### Parameters
#### Path Parameters
- **i** (*gosnmp.SnmpPacket) - The incoming SNMP packet.

### Signature
```go
func (t *SubAgent) Serve(i *gosnmp.SnmpPacket) (*gosnmp.SnmpPacket, error)
```
```

--------------------------------

### Asn1Counter64Wrap Function Signature

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Function signature for wrapping a uint64 value as ASN.1 Counter64.

```go
func Asn1Counter64Wrap(i uint64) interface{}
```

--------------------------------

### IReplyer Interface

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

IReplyer defines an interface for handling SNMP PDU replies and server shutdown.

```go
type IReplyer interface {
	ReplyPDU([]byte) error
	Shutdown()
}
```

--------------------------------

### Key Generation Functions

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Functions for generating security keys and salts, particularly for USM (User-based Security Model).

```APIDOC
## GenKeys

### Description
Generates keys for the USM security parameters.

### Signature
```go
func GenKeys(sp *gosnmp.UsmSecurityParameters)
```

## GenSalt

### Description
Generates a salt for the USM security parameters.

### Signature
```go
func GenSalt(sp *gosnmp.UsmSecurityParameters)
```
```

--------------------------------

### Asn1Gauge32Wrap Function Signature

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Function signature for wrapping a uint value as ASN.1 Gauge32.

```go
func Asn1Gauge32Wrap(i uint) interface{}
```

--------------------------------

### VerifyOid Function Signature

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Function signature for verifying an Object Identifier string. Each number should be a positive uint32.

```go
func VerifyOid(oid string) error
```

--------------------------------

### MasterAgent ResponseForBuffer Method

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

ResponseForBuffer processes a byte buffer containing SNMP data and returns a byte slice representing the response, along with any potential error.

```go
func (t *MasterAgent) ResponseForBuffer(i []byte) ([]byte, error)
```

--------------------------------

### SecurityConfig Methods

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Methods for managing security configurations, particularly for USM (User-based Security Model).

```APIDOC
## SecurityConfig

### Methods

- **(v *SecurityConfig) FindForUser(name string) *gosnmp.UsmSecurityParameters**
  - Description: Finds the USM security parameters for a given user.
  - Parameters:
    - name (string) - The username to search for.
  - Returns:
    - *gosnmp.UsmSecurityParameters - The USM security parameters for the user, or nil if not found.
```

--------------------------------

### Define ByteStringCompareResultLessThen Constant

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Defines the constant for less than byte string comparison.

```go
const ByteStringCompareResultLessThen = -1
```

--------------------------------

### Asn1IPAddressWrap Function Signature

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Function signature for wrapping a net.IP value as ASN.1 IPAddress.

```go
func Asn1IPAddressWrap(i net.IP) interface{}
```

--------------------------------

### UDPListener.NextSnmp

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

NextSnmp waits for and retrieves the next SNMP packet from the listener.

```APIDOC
## UDPListener.NextSnmp

### Description
Waits for and retrieves the next SNMP packet from the listener.

### Signature
```go
func (udp *UDPListener) NextSnmp() ([]byte, IReplyer, error)
```
```

--------------------------------

### FuncPDUControlCheckPermission Type

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

FuncPDUControlCheckPermission checks for permission based on PDU type and context name. It returns PermissionAllowanceAllowed or PermissionAllowanceDenied.

```go
type FuncPDUControlCheckPermission func(pktVersion gosnmp.SnmpVersion, pduType gosnmp.PDUType, contextName string) PermissionAllowance
```

```go
return PermissionAllowanceAllowed / PermissionAllowanceDenied
```

--------------------------------

### NetworkOIDs

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer/mibImps/ifMib

NetworkOIDs Returns a list of network data, referencing external documentation for details.

```APIDOC
## NetworkOIDs

### Description
Returns a list of network data.
See http://www.net-snmp.org/docs/mibs/interfaces.html for more details.

### Signature
```go
func NetworkOIDs() []*GoSNMPServer.PDUValueControlItem
```
```

--------------------------------

### Asn1Uinteger32Unwrap Function Signature

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Function signature for unwrapping an ASN.1 Uinteger32 value.

```go
func Asn1Uinteger32Unwrap(i interface{}) uint32
```

--------------------------------

### DiscardLogger Info Method Signature

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Method signature for Info on DiscardLogger. Throws away log messages.

```go
func (*DiscardLogger) Info(args ...interface{})
```

--------------------------------

### FuncPDUControlCheckPermission

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

FuncPDUControlCheckPermission checks for permission. It returns PermissionAllowanceAllowed or PermissionAllowanceDenied.

```APIDOC
## FuncPDUControlCheckPermission

### Description
Checks for permission to perform an action based on PDU type and context.

### Type Signature
```
type FuncPDUControlCheckPermission func(pktVersion gosnmp.SnmpVersion, pduType gosnmp.PDUType, contextName string) PermissionAllowance
```

### Returns
- **PermissionAllowanceAllowed**: Indicates permission is granted.
- **PermissionAllowanceDenied**: Indicates permission is denied.
```

--------------------------------

### Find Security User

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Finds the security parameters for a given user name within the SecurityConfig.

```go
func (v *SecurityConfig) FindForUser(name string) *gosnmp.UsmSecurityParameters
```

--------------------------------

### DismanEventOids

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer/mibImps/dismanEventMib

DismanEventOids function provides sysUptime.

```APIDOC
## DismanEventOids

### Description
DismanEventOids function provides sysUptime.

### Signature
```go
func DismanEventOids() []*GoSNMPServer.PDUValueControlItem
```

### References
- http://www.oid-info.com/get/1.3.6.1.2.1.1.3.0
- http://www.net-snmp.org/docs/mibs/dismanEventMIB.html
```

--------------------------------

### Utility Functions

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Provides utility functions for SNMP operations.

```APIDOC
## Utility Functions

### Engine Time
- **DefaultGetAuthoritativeEngineTime() uint32**
  - Description: Retrieves the default authoritative engine time.
  - Returns:
    - uint32 - The default engine time.

### Key Generation
- **GenKeys(sp *gosnmp.UsmSecurityParameters)**
  - Description: Generates keys for USM security parameters.
  - Parameters:
    - sp (*gosnmp.UsmSecurityParameters) - The USM security parameters.

- **GenSalt(sp *gosnmp.UsmSecurityParameters)**
  - Description: Generates a salt for USM security parameters.
  - Parameters:
    - sp (*gosnmp.UsmSecurityParameters) - The USM security parameters.

### Object Identifier Validation
- **IsValidObjectIdentifier(oid string) (result bool)**
  - Description: Checks if a given string is a valid Object Identifier.
  - Parameters:
    - oid (string) - The Object Identifier string to validate.
  - Returns:
    - bool - True if the OID is valid, false otherwise.

- **VerifyOid(oid string) error**
  - Description: Verifies the format and structure of an Object Identifier.
  - Parameters:
    - oid (string) - The Object Identifier string to verify.
  - Returns:
    - error - An error if the OID is invalid.
```

--------------------------------

### DiscardLogger Warningf Method

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

The Warningf method of DiscardLogger discards formatted warning messages.

```go
func (*DiscardLogger) Warningf(format string, args ...interface{})
```

--------------------------------

### UDPListener.Address

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Address returns the network address the UDPListener is bound to.

```APIDOC
## UDPListener.Address

### Description
Returns the network address the UDPListener is bound to.

### Signature
```go
func (udp *UDPListener) Address() net.Addr
```
```

--------------------------------

### GenKeys Function Signature

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Function signature for generating keys using UsmSecurityParameters.

```go
func GenKeys(sp *gosnmp.UsmSecurityParameters)
```

--------------------------------

### SnmpLoggerAdapter

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

SnmpLoggerAdapter adapts a logger to the gosnmp interface, wrapping a logger for tracing.

```APIDOC
## SnmpLoggerAdapter

### Description
Adapts a logger to the gosnmp interface, wrapping a logger for tracing.

### Fields
- **ILogger** (ILogger) - The underlying logger interface.
```

--------------------------------

### MasterAgent.ResponseForPkt

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

ResponseForPkt processes an SnmpPacket and returns a response SnmpPacket.

```APIDOC
## (*MasterAgent) ResponseForPkt

### Description
Processes a structured `gosnmp.SnmpPacket` and returns a structured `gosnmp.SnmpPacket` as the response.

### Signature
```
func (t *MasterAgent) ResponseForPkt(i *gosnmp.SnmpPacket) (*gosnmp.SnmpPacket, error)
```

### Parameters
#### Arguments
- **i** (*gosnmp.SnmpPacket): The incoming SNMP packet structure.

### Returns
- **(*gosnmp.SnmpPacket)**: The response SNMP packet structure.
- **error**: An error if the packet processing fails.
```

--------------------------------

### DiscardLogger Fatalln Method Signature

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Method signature for Fatalln on DiscardLogger. Throws away log messages.

```go
func (*DiscardLogger) Fatalln(args ...interface{})
```

--------------------------------

### Define ByteStringCompareResultGreaterThen Constant

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Defines the constant for greater than byte string comparison.

```go
const ByteStringCompareResultGreaterThen = 1
```

--------------------------------

### SnmpLoggerAdapter Structure

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Adapts a logger to the gosnmp.ILogger interface, wrapping a logger for trace functionality.

```go
type SnmpLoggerAdapter struct {
	ILogger
}
```

--------------------------------

### Asn1IntegerWrap Function Signature

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Function signature for wrapping an int value as ASN.1 Integer.

```go
func Asn1IntegerWrap(i int) interface{}
```

--------------------------------

### DiscardLogger Tracef Method

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

The Tracef method of DiscardLogger discards formatted trace messages.

```go
func (*DiscardLogger) Tracef(format string, args ...interface{})
```

--------------------------------

### DiscardLogger Traceln Method

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

The Traceln method of DiscardLogger discards trace messages with newline.

```go
func (*DiscardLogger) Traceln(args ...interface{})
```

--------------------------------

### NewDiscardLogger Function

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

NewDiscardLogger creates and returns a new discard logger instance that implements the ILogger interface, effectively discarding all log messages.

```go
func NewDiscardLogger() ILogger
```

--------------------------------

### DiscardLogger Infof Method

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

The Infof method of DiscardLogger discards formatted log messages.

```go
func (*DiscardLogger) Infof(format string, args ...interface{})
```

--------------------------------

### Define ByteStringCompareResultEqual Constant

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Defines the constant for equal byte string comparison.

```go
const ByteStringCompareResultEqual = 0
```

--------------------------------

### MasterAgent.ResponseForBuffer

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

ResponseForBuffer processes a raw byte buffer and returns a response buffer.

```APIDOC
## (*MasterAgent) ResponseForBuffer

### Description
Processes a raw byte slice containing an SNMP packet and returns a byte slice representing the response.

### Signature
```
func (t *MasterAgent) ResponseForBuffer(i []byte) ([]byte, error)
```

### Parameters
#### Arguments
- **i** ([]byte): The raw byte slice containing the incoming SNMP packet.

### Returns
- **[]byte**: A byte slice representing the SNMP response.
- **error**: An error if the packet processing fails.
```

--------------------------------

### DiscardLogger Fatalf Method Signature

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Method signature for Fatalf on DiscardLogger. Throws away log messages.

```go
func (*DiscardLogger) Fatalf(format string, args ...interface{})
```

--------------------------------

### Define ErrNoSNMPInstance Variable

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Defines the error variable for missing SNMP instances.

```go
var ErrNoSNMPInstance = errors.New("ErrNoSNMPInstance")
```

--------------------------------

### Asn1OpaqueDoubleUnwrap Function Signature

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Function signature for unwrapping an ASN.1 OpaqueDouble value.

```go
func Asn1OpaqueDoubleUnwrap(i interface{}) float64
```

--------------------------------

### DiscardLogger Warnln Method

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

The Warnln method of DiscardLogger discards warning messages with newline.

```go
func (*DiscardLogger) Warnln(args ...interface{})
```

--------------------------------

### WrapLogrus Function

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

WrapLogrus takes a logrus.Logger and wraps it to create an ILogger compatible logger.

```go
func WrapLogrus(p *logrus.Logger) ILogger
```

--------------------------------

### Logger Interface and Constructors

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Defines the ILogger interface and provides constructors for different logger implementations.

```APIDOC
## Logger Interface and Constructors

### Interface: ILogger

This interface defines methods for logging messages at different levels (Debug, Error, Info, Warn, Fatal, Trace).

### Constructors:

- **NewDefaultLogger() ILogger**
  - Description: Creates a new instance of the default logger.
  - Returns:
    - ILogger - The default logger instance.

- **NewDiscardLogger() ILogger**
  - Description: Creates a new logger that discards all messages.
  - Returns:
    - ILogger - The discard logger instance.

- **WrapLogrus(p *logrus.Logger) ILogger**
  - Description: Wraps a logrus.Logger instance to conform to the ILogger interface.
  - Parameters:
    - p (*logrus.Logger) - The logrus logger to wrap.
  - Returns:
    - ILogger - The wrapped logger instance.
```

--------------------------------

### Reply SNMP PDU

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Sends a reply PDU over UDP.

```go
func (r *UDPReplyer) ReplyPDU(i []byte) error
```

--------------------------------

### Asn1OpaqueFloatWrap Function Signature

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Function signature for wrapping a float32 value as ASN.1 OpaqueFloat.

```go
func Asn1OpaqueFloatWrap(i float32) interface{}
```

--------------------------------

### Asn1Counter64Unwrap Function Signature

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Function signature for unwrapping an ASN.1 Counter64 value.

```go
func Asn1Counter64Unwrap(i interface{}) uint64
```

--------------------------------

### DiscardLogger Infoln Method

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

The Infoln method of DiscardLogger discards log messages with newline.

```go
func (*DiscardLogger) Infoln(args ...interface{})
```

--------------------------------

### Listen for UDP Packets

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Configures the SNMPServer to listen for UDP packets on a specified address and network protocol.

```go
func (server *SNMPServer) ListenUDP(l3proto, address string) error
```

--------------------------------

### Define ErrNoPermission Variable

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Defines the error variable for no permission scenarios.

```go
var ErrNoPermission = errors.New("ErrNoPermission")
```

--------------------------------

### ILogger Interface

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

ILogger defines the interface for logging operations, including methods for debug, error, fatal, info, trace, warn, and warning levels, with both formatted and non-formatted variants.

```go
type ILogger interface {
	Debug(args ...interface{})
	Debugf(format string, args ...interface{})
	Debugln(args ...interface{})
	Error(args ...interface{})
	Errorf(format string, args ...interface{})
	Errorln(args ...interface{})
	Fatal(args ...interface{})
	Fatalf(format string, args ...interface{})
	Fatalln(args ...interface{})
	Info(args ...interface{})
	Infof(format string, args ...interface{})
	Infoln(args ...interface{})
	Trace(args ...interface{})
	Tracef(format string, args ...interface{})
	Traceln(args ...interface{})
	Warn(args ...interface{})
	Warnf(format string, args ...interface{})
	Warning(args ...interface{})
	Warningf(format string, args ...interface{})
	Warningln(args ...interface{})
	Warnln(args ...interface{})
}
```

--------------------------------

### UDPListener.Shutdown

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Shutdown closes the UDP listener.

```APIDOC
## UDPListener.Shutdown

### Description
Closes the UDP listener.

### Signature
```go
func (udp *UDPListener) Shutdown()
```
```

--------------------------------

### DiscardLogger Warnf Method

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

The Warnf method of DiscardLogger discards formatted warning messages.

```go
func (*DiscardLogger) Warnf(format string, args ...interface{})
```

--------------------------------

### Asn1IPAddressUnwrap Function Signature

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Function signature for unwrapping an ASN.1 IPAddress value.

```go
func Asn1IPAddressUnwrap(i interface{}) net.IP
```

--------------------------------

### Receive Next SNMP Data

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Waits for and retrieves the next SNMP data packet from the UDP listener.

```go
func (udp *UDPListener) NextSnmp() ([]byte, IReplyer, error)
```

--------------------------------

### SecurityConfig

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

SecurityConfig holds security-related settings for SNMPv3.

```APIDOC
## SecurityConfig

### Description
Holds security-related settings for SNMPv3.

### Fields
- **NoSecurity** (bool) - If true, no security is used.
- **SnmpV3Only** (bool) - If true, only SNMPv3 is supported.
- **AuthoritativeEngineID** (SNMPEngineID) - The SNMPv3 Authoritative EngineID.
- **AuthoritativeEngineBoots** (uint32) - The SNMPv3 Authoritative EngineBoots.
- **OnGetAuthoritativeEngineTime** (FuncGetAuthoritativeEngineTime) - Called to get SNMPv3 AuthoritativeEngineTime. If nil, system boot time is used.
- **Users** ([]gosnmp.UsmSecurityParameters) - A list of users with their security parameters.
```

--------------------------------

### PermissionAllowance Enumeration

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Defines the PermissionAllowance enumeration to control access to OIDs. PermissionAllowanceAllowed permits access, while PermissionAllowanceDenied denies it.

```go
type PermissionAllowance int
```

```go
const PermissionAllowanceAllowed PermissionAllowance = 0
```

```go
const PermissionAllowanceDenied PermissionAllowance = 1
```

--------------------------------

### Asn1IntegerUnwrap Function Signature

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Function signature for unwrapping an ASN.1 Integer value.

```go
func Asn1IntegerUnwrap(i interface{}) int
```

--------------------------------

### Asn1Gauge32Unwrap Function Signature

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Function signature for unwrapping an ASN.1 Gauge32 value.

```go
func Asn1Gauge32Unwrap(i interface{}) uint
```

--------------------------------

### DiscardLogger Errorf Method Signature

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Method signature for Errorf on DiscardLogger. Throws away log messages.

```go
func (*DiscardLogger) Errorf(format string, args ...interface{})
```

--------------------------------

### DiscardLogger Debugf Method Signature

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Method signature for Debugf on DiscardLogger. Throws away log messages.

```go
func (*DiscardLogger) Debugf(format string, args ...interface{})
```

--------------------------------

### DiscardLogger Warningln Method

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

The Warningln method of DiscardLogger discards warning messages with newline.

```go
func (*DiscardLogger) Warningln(args ...interface{})
```

--------------------------------

### Shutdown UDPListener

Source: https://pkg.go.dev/github.com/slayercat/GoSNMPServer

Shuts down the UDP listener, releasing associated resources.

```go
func (udp *UDPListener) Shutdown()
```
Tokens:
Raw