org.onosproject.routing.bgp

Class BgpRouteEntry

java.lang.Object

org.onosproject.routing.RouteEntry

org.onosproject.routing.bgp.BgpRouteEntry

public class BgpRouteEntry
extends RouteEntry

Represents a route in BGP.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BgpRouteEntry.AsPath A class to represent AS Path.
static class	BgpRouteEntry.PathSegment A class to represent AS Path Segment.

Constructor Summary

Constructors

Constructor and Description
BgpRouteEntry(BgpSession bgpSession, org.onlab.packet.IpPrefix prefix, org.onlab.packet.IpAddress nextHop, byte origin, BgpRouteEntry.AsPath asPath, long localPref) Class constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Compares whether two objects are equal.
BgpRouteEntry.AsPath	getAsPath() Gets the route AS path.
BgpSession	getBgpSession() Gets the BGP Session the route was received on.
long	getLocalPref() Gets the route local preference.
long	getMultiExitDisc() Gets the route MED (Multi-Exit Discriminator).
byte	getOrigin() Gets the route origin: 0=IGP, 1=EGP, 2=INCOMPLETE.
int	hashCode() Computes the hash code.
String	toString()

Methods inherited from class org.onosproject.routing.RouteEntry

createBinaryString, isIp4, isIp6, nextHop, prefix, version

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BgpRouteEntry

public BgpRouteEntry(BgpSession bgpSession,
                     org.onlab.packet.IpPrefix prefix,
                     org.onlab.packet.IpAddress nextHop,
                     byte origin,
                     BgpRouteEntry.AsPath asPath,
                     long localPref)

Class constructor.

Parameters:

bgpSession - the BGP Session the route was received on

prefix - the prefix of the route

nextHop - the next hop of the route

origin - the route origin: 0=IGP, 1=EGP, 2=INCOMPLETE

asPath - the AS path

localPref - the route local preference

Method Detail

getBgpSession

public BgpSession getBgpSession()

Gets the BGP Session the route was received on.

Returns:

the BGP Session the route was received on

getOrigin

public byte getOrigin()

Gets the route origin: 0=IGP, 1=EGP, 2=INCOMPLETE.

Returns:

the route origin: 0=IGP, 1=EGP, 2=INCOMPLETE

getAsPath

public BgpRouteEntry.AsPath getAsPath()

Gets the route AS path.

Returns:

the route AS path

getLocalPref

public long getLocalPref()

Gets the route local preference.

Returns:

the route local preference

getMultiExitDisc

public long getMultiExitDisc()

Gets the route MED (Multi-Exit Discriminator).

Returns:

the route MED (Multi-Exit Discriminator)

equals

public boolean equals(Object other)

Compares whether two objects are equal.

NOTE: The bgpSession field is excluded from the comparison.

Overrides:

equals in class RouteEntry

Returns:

true if the two objects are equal, otherwise false.

hashCode

public int hashCode()

Computes the hash code.

NOTE: We return the base class hash code to avoid expensive computation

Overrides:

hashCode in class RouteEntry

Returns:

the object hash code

toString

public String toString()

Overrides:

toString in class RouteEntry