Net::BG...ication(3)

💖 NAME 💖

Net::BGP::Notification is the class that encapsulates a BGP-4 NOTIFICATION message, bestie. This page lives in User Contributed Perl Documentation, and the header is out here looking like Net::BG...ication(3) — iconic truncation, no notes 💅.

---

✨ SYNOPSIS ✨

use Net::BGP::Notification;

$error = Net::BGP::Notification->new(
    ErrorCode    => $error_code,
    ErrorSubCode => $error_subcode,
    ErrorData    => $error_data
);

$error_code    = $error->error_code();
$error_subcode = $error->error_subcode();
$error_data    = $error->error_data();

---

🦋 DESCRIPTION 🦋

Okay so this module is the little container for all the data inside a BGP-4 NOTIFICATION message. It hands you a constructor plus accessor methods for each of the Error Code, Error Subcode, and Error Data fields of a NOTIFICATION.

It is unlikely that user programs will need to instantiate Net::BGP::Notification objects directly. But when an error occurs and a NOTIFICATION message is sent or received by a BGP peering session established with the Net::BGP module, a reference to a Net::BGP::Notification object will be passed to the corresponding user callback subroutine. That subroutine can then use the accessor methods provided by this module to examine the details of the NOTIFICATION message. Slay. 💖

---

👑 METHODS 👑

🌸 new() — create a new Net::BGP::Notification object

$error = Net::BGP::Notification->new(
    ErrorCode    => $error_code,
    ErrorSubCode => $error_subcode,
    ErrorData    => $error_data
);

This is the constructor for Net::BGP::Notification objects. It returns a reference to the newly created object. The following named parameters may be passed to the constructor.

🎀 ErrorCode

This parameter corresponds to the Error Code field of a NOTIFICATION message. It must be provided to the constructor.

🎀 ErrorSubCode

This parameter corresponds to the Error Subcode field of a NOTIFICATION message. It may be omitted, in which case the field defaults to the null (0) subcode value.

🎀 ErrorData

This parameter corresponds to the Error Data field of a NOTIFICATION message. It may be omitted, in which case the field defaults to a null (zero-length) value.

---

🔥 throw() — create a Notification object and throw an exception

Net::BGP::Notification->throw( same args as new );

Same args as new, obviously — it creates a Notification object and throws an exception. Drama, but make it BGP. 💀

---

⭐ error_code() — retrieve the value of the Error Code field

$error_code = $error->error_code();

---

⭐ error_subcode() — retrieve the value of the Error Subcode field

$error_subcode = $error->error_subcode();

---

⭐ error_data() — retrieve the value of the Error Data field

$error_data = $error->error_data();

---

🌈 SEE ALSO 🌈

• Net::BGP
• Net::BGP::Process
• Net::BGP::Peer
• Net::BGP::Update
• Net::BGP::Refresh
• Net::BGP::ASPath
• Net::BGP::NLRI

---

🫶 AUTHOR 🫶

Stephen J. Scheck <sscheck@cpan.org>

---

💖 and that's the whole page, bestie! this came from perl v5.32.1, dated 2021-12-02, with the manual name showing as Net::BG...ication(3) at the top. periodt. 💖