@spec all_error_atoms() :: [
  :no_error
  | :too_big
  | :no_such_name
  | :bad_value
  | :read_only
  | :gen_err
  | :no_access
  | :wrong_type
  | :wrong_length
  | :wrong_encoding
  | :wrong_value
  | :no_creation
  | :inconsistent_value
  | :resource_unavailable
  | :commit_failed
  | :undo_failed
  | :authorization_error
  | :not_writable
  | :inconsistent_name
]

Returns a list of all standard SNMP error atoms.

Examples

iex> atoms = SnmpKit.SnmpLib.Error.all_error_atoms()
iex> :no_error in atoms
true
iex> :gen_err in atoms
true

@spec all_error_codes() :: [non_neg_integer()]

Returns a list of all standard SNMP error codes.

Examples

iex> codes = SnmpKit.SnmpLib.Error.all_error_codes()
iex> 0 in codes
true
iex> 5 in codes
true

@spec bad_value() :: 3

Returns the numeric code for 'bad value' error status.

The value provided in a SET operation is invalid for the variable.

Examples

iex> SnmpKit.SnmpLib.Error.bad_value()
3

@spec create_error_response(map(), error_status(), error_index()) ::
  {:ok, map()} | {:error, atom()}

Creates an SNMP error response PDU.

Generates a properly formatted error response based on the original request and the error condition that occurred.

Parameters

• request_pdu: Original request PDU
• error_status: Error status code or atom
• error_index: Index of the varbind that caused the error (1-based)

Returns

• {:ok, error_pdu}: Successfully created error response
• {:error, reason}: Failed to create error response

Examples

request = %{type: :get_request, request_id: 123, varbinds: [...]}
{:ok, error_response} = SnmpKit.SnmpLib.Error.create_error_response(
  request,
  :no_such_name,
  1
)

@spec error_atom(error_status()) :: atom()

Converts error status code to atom representation.

Examples

iex> SnmpKit.SnmpLib.Error.error_atom(2)
:no_such_name

iex> SnmpKit.SnmpLib.Error.error_atom(999)
:unknown_error

@spec error_code(atom() | String.t()) :: non_neg_integer()

Converts error atom or name to numeric code.

Examples

iex> SnmpKit.SnmpLib.Error.error_code(:no_such_name)
2

iex> SnmpKit.SnmpLib.Error.error_code("bad_value")
3

@spec error_name(error_status()) :: String.t()

Returns the human-readable name for an error status code.

Parameters

• code: Numeric error status code or atom

Returns

• String name of the error status
• "unknown_error" for unrecognized codes

Examples

iex> SnmpKit.SnmpLib.Error.error_name(0)
"no_error"

iex> SnmpKit.SnmpLib.Error.error_name(:too_big)
"too_big"

iex> SnmpKit.SnmpLib.Error.error_name(999)
"unknown_error"

@spec error_severity(error_status()) :: :info | :warning | :error

Categorizes error by severity level.

Returns

• :info - No error
• :warning - Retriable errors
• :error - Non-retriable errors

Examples

iex> SnmpKit.SnmpLib.Error.error_severity(:no_error)
:info

iex> SnmpKit.SnmpLib.Error.error_severity(:too_big)
:warning

iex> SnmpKit.SnmpLib.Error.error_severity(:no_such_name)
:error

@spec format_error(error_status(), error_index(), varbinds()) :: String.t()

Formats an SNMP error for human-readable display.

Parameters

• error_status: Error status code (integer or atom)
• error_index: Index of the varbind that caused the error (1-based)
• varbinds: List of varbinds from the request (optional)

Returns

Formatted error string suitable for logging or display.

Examples

iex> SnmpKit.SnmpLib.Error.format_error(2, 1, [])
"SNMP Error: no_such_name (2) at index 1"

iex> varbinds = [{[1,3,6,1,2,1,1,1,0], "test"}]
iex> SnmpKit.SnmpLib.Error.format_error(:bad_value, 1, varbinds)
"SNMP Error: bad_value (3) at index 1 - OID: 1.3.6.1.2.1.1.1.0"

@spec gen_err() :: 5

Returns the numeric code for 'general error' status.

A general error occurred that doesn't fit other categories.

Examples

iex> SnmpKit.SnmpLib.Error.gen_err()
5

@spec no_error() :: 0

Returns the numeric code for 'no error' status.

Examples

iex> SnmpKit.SnmpLib.Error.no_error()
0

@spec no_such_name() :: 2

Returns the numeric code for 'no such name' error status.

The requested OID does not exist on the agent.

Examples

iex> SnmpKit.SnmpLib.Error.no_such_name()
2

@spec read_only() :: 4

Returns the numeric code for 'read only' error status.

Attempted to set a read-only variable.

Examples

iex> SnmpKit.SnmpLib.Error.read_only()
4

@spec retriable_error?(error_status()) :: boolean()

Determines if an error status indicates a retriable condition.

Some SNMP errors are temporary and operations can be retried, while others indicate permanent failures.

Retriable Errors

• too_big - Can retry with smaller request
• gen_err - General error, may be temporary
• resource_unavailable - Temporary resource constraint

Non-Retriable Errors

• no_such_name - OID doesn't exist
• bad_value - Invalid value provided
• read_only - Attempted to write read-only variable
• no_access - Access denied
• Most SNMPv2c specific errors

Examples

iex> SnmpKit.SnmpLib.Error.retriable_error?(:too_big)
true

iex> SnmpKit.SnmpLib.Error.retriable_error?(:no_such_name)
false

@spec too_big() :: 1

Returns the numeric code for 'too big' error status.

The response message would be too large to fit in a single SNMP message.

Examples

iex> SnmpKit.SnmpLib.Error.too_big()
1

@spec valid_error_status?(any()) :: boolean()

Validates an error status code.

Examples

iex> SnmpKit.SnmpLib.Error.valid_error_status?(2)
true

iex> SnmpKit.SnmpLib.Error.valid_error_status?(:no_such_name)
true

iex> SnmpKit.SnmpLib.Error.valid_error_status?(999)
false