org.onosproject.bgpio.types

Class WideCommunityAttrHeader

java.lang.Object

org.onosproject.bgpio.types.WideCommunityAttrHeader

All Implemented Interfaces:

BgpValueType

public class WideCommunityAttrHeader
extends Object
implements BgpValueType

Provides implementation of BGP wide community attribute header.

Field Summary

Fields

Modifier and Type	Field and Description
static short	HEADER_LENGTH
static short	TYPE

Constructor Summary

Constructors

Constructor and Description
WideCommunityAttrHeader(byte flag, byte hopCount, short length) Wide community attribute header.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object o) Compares two objects.
boolean	equals(Object obj)
byte	flag() Returns wide community flag.
short	getType() Returns the Type of BGP Message.
int	hashCode()
byte	hopCount() Returns hop count for wide community attribute.
short	length() Returns length of wide community attribute.
static WideCommunityAttrHeader	of(byte flag, byte hopCount, short length) Returns object of this class with specified values.
static WideCommunityAttrHeader	read(org.jboss.netty.buffer.ChannelBuffer c) Reads the channel buffer and returns object of WideCommunityAttrHeader.
void	setFlag(byte flag) Sets wide community flag.
void	setHopCount(byte hopCount) Sets wide community hop count.
void	setLength(short length) Sets wide community length.
String	toString()
int	write(org.jboss.netty.buffer.ChannelBuffer c) Writes the byte Stream of BGP Message to channel buffer.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final short TYPE

See Also:

Constant Field Values

HEADER_LENGTH

public static final short HEADER_LENGTH

See Also:

Constant Field Values

Constructor Detail

WideCommunityAttrHeader

public WideCommunityAttrHeader(byte flag,
                               byte hopCount,
                               short length)

Wide community attribute header.

Parameters:

flag - to apply to all wide community container types

hopCount - represents the forwarding radius, in units of AS hops, for the given Wide BGP Community

length - field represents the total length of a given container

Method Detail

of

public static WideCommunityAttrHeader of(byte flag,
                                         byte hopCount,
                                         short length)

Returns object of this class with specified values.

Parameters:

flag - flag to apply to all wide community container types

hopCount - represents the forwarding radius, in units of AS hops, for the given Wide BGP Community

length - field represents the total length of a given container

Returns:

wide community attribute header

flag

public byte flag()

Returns wide community flag.

Returns:

wide community flag

setFlag

public void setFlag(byte flag)

Sets wide community flag.

Parameters:

flag - to apply to all wide community container types

hopCount

public byte hopCount()

Returns hop count for wide community attribute.

Returns:

hop count from wide community

setHopCount

public void setHopCount(byte hopCount)

Sets wide community hop count.

Parameters:

hopCount - represents the forwarding radius, in units of AS hops, for the given Wide BGP Community

length

public short length()

Returns length of wide community attribute.

Returns:

length of wide community attribute

setLength

public void setLength(short length)

Sets wide community length.

Parameters:

length - total length of a given container

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

write

public int write(org.jboss.netty.buffer.ChannelBuffer c)

Description copied from interface: BgpValueType

Writes the byte Stream of BGP Message to channel buffer.

Specified by:

write in interface BgpValueType

Parameters:

c - channel buffer

Returns:

length written to channel buffer

read

public static WideCommunityAttrHeader read(org.jboss.netty.buffer.ChannelBuffer c)
                                    throws BgpParseException

Reads the channel buffer and returns object of WideCommunityAttrHeader.

Parameters:

c - ChannelBuffer

Returns:

object of WideCommunityAttrHeader

Throws:

BgpParseException - if a parsing error occurs

getType

public short getType()

Description copied from interface: BgpValueType

Returns the Type of BGP Message.

Specified by:

getType in interface BgpValueType

Returns:

short value of type

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(Object o)

Description copied from interface: BgpValueType

Compares two objects.

Specified by:

compareTo in interface BgpValueType

Parameters:

o - object

Returns:

result after comparing two objects