NAME

"Net::BGP::Refresh" - Class encapsulating BGP-4 REFRESH message

SYNOPSIS

    use Net::BGP::Refresh;

    $refresh = Net::BGP::Refresh->new(
        AFI      => $address_family_identifier,
        SAFI     => $subsequent_address_family_identifier
    );

    $address_family_identifier            = $refresh->afi();
    $subsequent_address_family_identifier = $refresh->safi();

    $peer->refresh($refresh);

DESCRIPTION

This module encapsulates the data contained in a BGP-4 REFRESH message as specified by RFC 2918. It provides a constructor, and accessor methods for each of the fields, AFI and SAFI, of a REFRESH message. To refresh the route table for a given address family, call the peer object's refresh() function with a "Net::BGP::Refresh" object as argument.

METHODS

new() - create a new "Net::BGP::Refresh" object

    $refresh = Net::BGP::Refresh->new(
        AFI      => $address_family_identifier,
        SAFI     => $subsequent_address_family_identifier
    );

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

AFI

This parameter corresponds to the Address Family Identifier field of a REFRESH message. Default is AFI_IP4.

SAFI

This parameter corresponds to the Subsequent Address Family Identifier field of a REFRESH message. Default is SAFI_BOTH.

afi() - retrieve the value of the Address Family Identifier field

    $address_family_identifier            = $refresh->afi();

safi() - retrieve the value of the Subsequent Address Family Identifier field

    $subsequent_address_family_identifier = $refresh->safi();

AUTHOR

Stephen J. Scheck <sscheck@cpan.org>