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

NAME

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

SYNOPSIS

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

DESCRIPTION

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

METHODS

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

SEE ALSO

78       Net::BGP, Net::BGP::Process, Net::BGP::Peer, Net::BGP::Update
79

AUTHOR

81       Stephen J. Scheck <sscheck@cpan.org>
82
83
84
85perl v5.34.0                      2021-07-22         Net::BGP::Notification(3)
Impressum