GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  NET::BGP::NOTIFICATION (3)

.ds Aq ’

NAME

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

CONTENTS

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

This module encapsulates the data contained in a BGP-4 NOTIFICATION message. It provides a constructor, and 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 <B>Net::BGP::NotificationB> objects directly. However, when an error occurs and a NOTIFICATION message is sent or received by a BGP peering session established with the <B>Net::BGPB> module, a reference to a <B>Net::BGP::NotificationB> object will be passed to the corresponding user callback subroutine. The subroutine can then use the accessor methods provided by this module to examine the details of the NOTIFICATION message.

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 );



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

<B>Net::BGPB>, <B>Net::BGP::ProcessB>, <B>Net::BGP::PeerB>, <B>Net::BGP::UpdateB>

AUTHOR

Stephen J. Scheck <code@neurosphere.com>
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 NET::BGP::NOTIFICATION (3) 2015-01-27

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.