snmpa_notification_delivery_info_receiver — snmp v5.20.1

Search documentation of snmp

# snmpa_notification_delivery_info_receiver behaviour (snmp v5.20.1)

View Source

Behaviour module for the SNMP agent notification delivery information receiver.

This module defines the behaviour of the notification delivery information receiver.

When the user sends a notification (see `snmpa:send_notification2/3`), the user can (optionally) choose to receive delivery information (was the message received and acknowledged by the target(s)). This behaviour describes a way for the user to get such (delivery) information.

A `snmpa_notification_delivery_info_receiver` compliant module must export the following functions:

- `delivery_targets/3`
- `delivery_info/4`

The semantics of them and their exact signatures are explained below.

Legacy notification delivery information receiver modules used a target argument of the form `{IpAddr, PortNumber}` instead of `{Domain, Addr}`, and if the SNMP Agent is run without changing the configuration to use transport domains the notification delivery information receiver will still get the old arguments and work as before.

# Summary

## Types

notification_delivery_info()

How shall (notification) delivery info be reported.

transportAddressWithPort()
transportDomain()

## Callbacks

delivery_info(Tag, Targets, DeliveryResult, Extra)

Inform about delivery result.

delivery_targets(Tag, Targets, Extra)

Inform about target addresses.

# Types

# notification_delivery_info()

    -type notification_delivery_info() ::
              #snmpa_notification_delivery_info{tag :: term(), mod :: term(), extra :: term()}.

How shall (notification) delivery info be reported.

This record defines the info related to inform delivery info. That is, when sending an inform, info about the delivery (such if it was acknowledged) will be delivered using the info in this record.

The delivery will be performed according to:

    	Mod:delivery_targets(Tag, Addresses, Extra)
    	Mod:delivery_info(Tag, Address, DeliveryResult, Extra)

The Extra is any term, provided by the user.

The fields of this record has the following meaning:

- `tag = term()` - Value selected by the user to identify this sending

- `mod = module()` - A module implementing the `snmpa_notification_delivery_info_receiver` behaviour.

- `extra = term()` - This is any extra info the user wants to have supplied when the functions in the callback module is called. Provided when calling the send function.

# transportAddressWithPort()

(not exported)

    -type transportAddressWithPort() :: snmpa_conf:transportAddressWithPort().

# transportDomain()

(not exported)

    -type transportDomain() :: snmpa_conf:transportDomain().

# Callbacks

# delivery_info(Tag, Targets, DeliveryResult, Extra)

    -callback delivery_info(Tag, Targets, DeliveryResult, Extra) -> snmp:void()
                               when
                                   Tag :: term(),
                                   Targets :: [Target],
                                   Target :: {transportDomain(), transportAddressWithPort()},
                                   DeliveryResult :: no_response | got_response,
                                   Extra :: term().

Inform about delivery result.

This function is called for each target in the `Targets` argument of the `delivery_targets/3` function, see above.

The purpose is to inform the `receiver` of the result of the delivery (was the notification acknowledged or not) for each target.

# delivery_targets(Tag, Targets, Extra)

    -callback delivery_targets(Tag, Targets, Extra) -> snmp:void()
                                  when
                                      Tag :: term(),
                                      Targets :: [Target],
                                      Target :: {transportDomain(), transportAddressWithPort()},
                                      Extra :: term().

Inform about target addresses.

This is the first function called when a notification delivery is in progress. It informs the `receiver` which targets will get the notification. The result of the delivery will be provided via successive calls to `delivery_info/4` function, see below.