1Net::BGP::Notification(U3s)er Contributed Perl DocumentatNieotn::BGP::Notification(3)
2
3
4

NAME

6       "Net::BGP::Notification" - Class encapsulating BGP-4 NOTIFICATION
7       message
8

SYNOPSIS

10           use Net::BGP::Notification;
11
12           $error = Net::BGP::Notification->new(
13               ErrorCode    => $error_code,
14               ErrorSubCode => $error_subcode,
15               ErrorData    => $error_data
16           );
17
18           $error_code    = $error->error_code();
19           $error_subcode = $error->error_subcode();
20           $error_data    = $error->error_data();
21

DESCRIPTION

23       This module encapsulates the data contained in a BGP-4 NOTIFICATION
24       message.  It provides a constructor, and accessor methods for each of
25       the Error Code, Error Subcode, and Error Data fields of a NOTIFICATION.
26       It is unlikely that user programs will need to instantiate
27       "Net::BGP::Notification" objects directly. However, when an error
28       occurs and a NOTIFICATION message is sent or received by a BGP peering
29       session established with the Net::BGP module, a reference to a
30       "Net::BGP::Notification" object will be passed to the corresponding
31       user callback subroutine. The subroutine can then use the accessor
32       methods provided by this module to examine the details of the
33       NOTIFICATION message.
34

METHODS

36       new() - create a new "Net::BGP::Notification" object
37
38           $error = Net::BGP::Notification->new(
39               ErrorCode    => $error_code,
40               ErrorSubCode => $error_subcode,
41               ErrorData    => $error_data
42           );
43
44       This is the constructor for "Net::BGP::Notification" objects. It
45       returns a reference to the newly created object. The following named
46       parameters may be passed to the constructor.
47
48   ErrorCode
49       This parameter corresponds to the Error Code field of a NOTIFICATION
50       message. It must be provided to the constructor.
51
52   ErrorSubCode
53       This parameter corresponds to the Error Subcode field of a NOTIFICATION
54       message. It may be omitted, in which case the field defaults to the
55       null (0) subcode value.
56
57   ErrorData
58       This parameter corresponds to the Error Data field of a NOTIFICATION
59       message. It may be omitted, in which case the field defaults to a null
60       (zero-length) value.
61
62       throw() - create a Notification object and throw an exception
63
64           Net::BGP::Notification->throw( same args as new );
65
66       error_code() - retrieve the value of the Error Code field
67
68           $error_code = $error->error_code();
69
70       error_subcode() - retrieve the value of the Error Subcode field
71
72           $error_subcode = $error->error_subcode();
73
74       error_data() - retrieve the value of the Error Data field
75
76           $error_data = $error->error_data();
77

SEE ALSO

79       Net::BGP
80       Net::BGP::Process
81       Net::BGP::Peer
82       Net::BGP::Update
83       Net::BGP::Refresh
84       Net::BGP::ASPath
85       Net::BGP::NLRI
86

AUTHOR

88       Stephen J. Scheck <sscheck@cpan.org>
89
90
91
92perl v5.36.0                      2023-01-20         Net::BGP::Notification(3)
Impressum