org.onosproject.routing.bgp

Class BgpSessionInfo

java.lang.Object

org.onosproject.routing.bgp.BgpSessionInfo

public class BgpSessionInfo
extends Object

Class for keeping information about a BGP session. There are two instances per each BGP peer session: one to keep the local information about the BGP session, and another to keep information about the remote BGP peer.

Constructor Summary

Constructors

Constructor and Description
BgpSessionInfo()

Method Summary

Modifier and Type	Method and Description
SocketAddress	address() Gets the BGP session address: local or remote.
long	as4Number() Gets the BGP session AS4 number: local or remote.
boolean	as4OctetCapability() Gets the BGP session 4 octet AS path capability: local or remote.
long	asNumber() Gets the BGP session AS number: local or remote.
org.onlab.packet.Ip4Address	bgpId() Gets the BGP session BGP Identifier as an IPv4 address: local or remote.
int	bgpVersion() Gets the BGP session BGP version: local or remote.
long	holdtime() Gets the BGP session holdtime: local or remote.
org.onlab.packet.Ip4Address	ip4Address() Gets the BGP session IPv4 address: local or remote.
boolean	ipv4Multicast() Gets the BGP session AFI/SAFI configuration for IPv4 multicast: local or remote.
boolean	ipv4Unicast() Gets the BGP session AFI/SAFI configuration for IPv4 unicast: local or remote.
boolean	ipv6Multicast() Gets the BGP session AFI/SAFI configuration for IPv6 multicast: local or remote.
boolean	ipv6Unicast() Gets the BGP session AFI/SAFI configuration for IPv6 unicast: local or remote.
boolean	mpExtensions() Gets the BGP Multiprotocol Extensions: local or remote.
void	setAddress(SocketAddress address) Sets the BGP session address: local or remote.
void	setAs4Number(long as4Number) Sets the BGP session AS4 number: local or remote.
void	setAs4OctetCapability() Sets the BGP session 4 octet AS path capability.
void	setAsNumber(long asNumber) Sets the BGP session AS number: local or remote.
void	setBgpId(org.onlab.packet.Ip4Address bgpId) Sets the BGP session BGP Identifier as an IPv4 address: local or remote.
void	setBgpVersion(int bgpVersion) Sets the BGP session BGP version: local or remote.
void	setHoldtime(long holdtime) Sets the BGP session holdtime: local or remote.
void	setIp4Address(org.onlab.packet.Ip4Address ip4Address) Sets the BGP session IPv4 address: local or remote.
void	setIpv4Multicast() Sets the BGP session AFI/SAFI configuration for IPv4 multicast: local or remote.
void	setIpv4Unicast() Sets the BGP session AFI/SAFI configuration for IPv4 unicast: local or remote.
void	setIpv6Multicast() Sets the BGP session AFI/SAFI configuration for IPv6 multicast: local or remote.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BgpSessionInfo

public BgpSessionInfo()

Method Detail

address

public SocketAddress address()

Gets the BGP session address: local or remote.

Returns:

the BGP session address

setAddress

public void setAddress(SocketAddress address)

Sets the BGP session address: local or remote.

Parameters:

address - the BGP session address to set

ip4Address

public org.onlab.packet.Ip4Address ip4Address()

Gets the BGP session IPv4 address: local or remote.

Returns:

the BGP session IPv4 address

setIp4Address

public void setIp4Address(org.onlab.packet.Ip4Address ip4Address)

Sets the BGP session IPv4 address: local or remote.

Parameters:

ip4Address - the BGP session IPv4 address to set

bgpVersion

public int bgpVersion()

Gets the BGP session BGP version: local or remote.

Returns:

the BGP session BGP version

setBgpVersion

public void setBgpVersion(int bgpVersion)

Sets the BGP session BGP version: local or remote.

Parameters:

bgpVersion - the BGP session BGP version to set

asNumber

public long asNumber()

Gets the BGP session AS number: local or remote.

Returns:

the BGP session AS number

setAsNumber

public void setAsNumber(long asNumber)

Sets the BGP session AS number: local or remote.

Parameters:

asNumber - the BGP session AS number to set

as4Number

public long as4Number()

Gets the BGP session AS4 number: local or remote.

Returns:

the BGP session AS4 number

setAs4Number

public void setAs4Number(long as4Number)

Sets the BGP session AS4 number: local or remote.

Parameters:

as4Number - the BGP session AS4 number to set

holdtime

public long holdtime()

Gets the BGP session holdtime: local or remote.

Returns:

the BGP session holdtime

setHoldtime

public void setHoldtime(long holdtime)

Sets the BGP session holdtime: local or remote.

Parameters:

holdtime - the BGP session holdtime to set

bgpId

public org.onlab.packet.Ip4Address bgpId()

Gets the BGP session BGP Identifier as an IPv4 address: local or remote.

Returns:

the BGP session BGP Identifier as an IPv4 address

setBgpId

public void setBgpId(org.onlab.packet.Ip4Address bgpId)

Sets the BGP session BGP Identifier as an IPv4 address: local or remote.

Parameters:

bgpId - the BGP session BGP Identifier to set

mpExtensions

public boolean mpExtensions()

Gets the BGP Multiprotocol Extensions: local or remote.

Returns:

true if the BGP Multiprotocol Extensions are enabled, otherwise false

ipv4Unicast

public boolean ipv4Unicast()

Gets the BGP session AFI/SAFI configuration for IPv4 unicast: local or remote.

Returns:

the BGP session AFI/SAFI configuration for IPv4 unicast

setIpv4Unicast

public void setIpv4Unicast()

Sets the BGP session AFI/SAFI configuration for IPv4 unicast: local or remote.

ipv4Multicast

public boolean ipv4Multicast()

Gets the BGP session AFI/SAFI configuration for IPv4 multicast: local or remote.

Returns:

the BGP session AFI/SAFI configuration for IPv4 multicast

setIpv4Multicast

public void setIpv4Multicast()

Sets the BGP session AFI/SAFI configuration for IPv4 multicast: local or remote.

ipv6Unicast

public boolean ipv6Unicast()

Gets the BGP session AFI/SAFI configuration for IPv6 unicast: local or remote.

Returns:

the BGP session AFI/SAFI configuration for IPv6 unicast

ipv6Multicast

public boolean ipv6Multicast()

Gets the BGP session AFI/SAFI configuration for IPv6 multicast: local or remote.

Returns:

the BGP session AFI/SAFI configuration for IPv6 multicast

setIpv6Multicast

public void setIpv6Multicast()

Sets the BGP session AFI/SAFI configuration for IPv6 multicast: local or remote.

as4OctetCapability

public boolean as4OctetCapability()

Gets the BGP session 4 octet AS path capability: local or remote.

Returns:

true when the BGP session has 4 octet AS path capability

setAs4OctetCapability

public void setAs4OctetCapability()

Sets the BGP session 4 octet AS path capability.