org.onosproject.bgp.controller

Interface BgpPeer

public interface BgpPeer

Represents the peer side of an BGP peer.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BgpPeer.FlowSpecOperation

Method Summary

Modifier and Type	Method and Description
void	buildAdjRibIn(List<BgpValueType> pathAttr) Maintaining Adj-RIB-In separately for each peer.
String	channelId() Identifies the channel used to communicate with the bgp peer.
void	disconnectPeer() Disconnects the bgp peer by closing the TCP connection.
BgpFactory	factory() Provides the factory for BGP version.
org.jboss.netty.channel.Channel	getChannel() Gets the associated Netty channel handler for this bgp peer.
boolean	isConnected() Checks if the bgp peer is still connected.
boolean	isHandshakeComplete() Checks whether the handshake is complete.
void	sendMessage(BgpMessage msg) Writes the message to the peer.
void	sendMessage(List<BgpMessage> msgs) Writes the BGPMessage list to the peer.
BgpSessionInfo	sessionInfo() Return the BGP session info.
void	setChannel(org.jboss.netty.channel.Channel channel) Sets the associated Netty channel for this bgp peer.
void	setConnected(boolean connected) Sets whether the bgp peer is connected.
void	updateFlowSpec(BgpPeer.FlowSpecOperation operType, BgpFlowSpecRouteKey routeKey, BgpFlowSpecNlri flowSpec, WideCommunity wideCommunity) Updates flow specification rule.

Method Detail

setChannel

void setChannel(org.jboss.netty.channel.Channel channel)

Sets the associated Netty channel for this bgp peer.

Parameters:

channel - the Netty channel

getChannel

org.jboss.netty.channel.Channel getChannel()

Gets the associated Netty channel handler for this bgp peer.

Returns:

Channel channel connected.

setConnected

void setConnected(boolean connected)

Sets whether the bgp peer is connected.

Parameters:

connected - whether the bgp peer is connected

isHandshakeComplete

boolean isHandshakeComplete()

Checks whether the handshake is complete.

Returns:

true is finished, false if not.

sendMessage

void sendMessage(BgpMessage msg)

Writes the message to the peer.

Parameters:

msg - the message to write

sendMessage

void sendMessage(List<BgpMessage> msgs)

Writes the BGPMessage list to the peer.

Parameters:

msgs - the messages to be written

factory

BgpFactory factory()

Provides the factory for BGP version.

Returns:

BGP version specific factory.

isConnected

boolean isConnected()

Checks if the bgp peer is still connected.

Returns:

whether the bgp peer is still connected

disconnectPeer

void disconnectPeer()

Disconnects the bgp peer by closing the TCP connection. Results in a call to the channel handler's channelDisconnected method for cleanup

channelId

String channelId()

Identifies the channel used to communicate with the bgp peer.

Returns:

string representation of the connection to the peer

buildAdjRibIn

void buildAdjRibIn(List<BgpValueType> pathAttr)
            throws BgpParseException

Maintaining Adj-RIB-In separately for each peer.

Parameters:

pathAttr - list of Bgp path attributes

Throws:

BgpParseException - while building Adj-Rib-In

sessionInfo

BgpSessionInfo sessionInfo()

Return the BGP session info.

Returns:

sessionInfo bgp session info

updateFlowSpec

void updateFlowSpec(BgpPeer.FlowSpecOperation operType,
                    BgpFlowSpecRouteKey routeKey,
                    BgpFlowSpecNlri flowSpec,
                    WideCommunity wideCommunity)

Updates flow specification rule.

Parameters:

operType - operation type add or delete or update

routeKey - flow route key for the flow rule

flowSpec - BGP flow specification components

wideCommunity - for route policy