org.onosproject.incubator.net.neighbour.impl

Class DefaultNeighbourMessageContext

java.lang.Object

org.onosproject.incubator.net.neighbour.impl.DefaultNeighbourMessageContext

All Implemented Interfaces:

NeighbourMessageContext

@Beta
public class DefaultNeighbourMessageContext
extends Object
implements NeighbourMessageContext

Default implementation of a neighbour message context.

Method Summary

Modifier and Type	Method and Description
static NeighbourMessageContext	createContext(org.onlab.packet.Ethernet eth, org.onosproject.net.ConnectPoint inPort, NeighbourMessageActions actions) Attempts to create a MessageContext for the given Ethernet frame.
void	drop() Drops the incoming message.
org.onlab.packet.MacAddress	dstMac() Gets the destination MAC address of the message.
boolean	equals(Object obj)
void	flood() Floods the incoming message out all ports except the input port.
void	forward(org.onosproject.net.ConnectPoint outPort) Forwards the message to a given output port.
void	forward(Interface outIntf) Forwards the message to a given interface.
int	hashCode()
org.onosproject.net.ConnectPoint	inPort() Gets the port where the packet came in to the network.
org.onlab.packet.Ethernet	packet() Gets the full parsed representation of the packet.
NeighbourProtocol	protocol() Gets the protocol of the packet.
void	reply(org.onlab.packet.MacAddress targetMac) Replies to the request message with a given MAC address.
org.onlab.packet.IpAddress	sender() Gets the source IP address of the message.
org.onlab.packet.MacAddress	srcMac() Gets the source MAC address of the message.
org.onlab.packet.IpAddress	target() Gets the target IP address of the message.
NeighbourMessageType	type() Gets the message type of the packet.
org.onlab.packet.VlanId	vlan() Gets the vlan of the packet, if any.

Methods inherited from class java.lang.Object

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

Method Detail

inPort

public org.onosproject.net.ConnectPoint inPort()

Description copied from interface: NeighbourMessageContext

Gets the port where the packet came in to the network.

Specified by:

inPort in interface NeighbourMessageContext

Returns:

connect point

packet

public org.onlab.packet.Ethernet packet()

Description copied from interface: NeighbourMessageContext

Gets the full parsed representation of the packet.

Specified by:

packet in interface NeighbourMessageContext

Returns:

ethernet header

protocol

public NeighbourProtocol protocol()

Description copied from interface: NeighbourMessageContext

Gets the protocol of the packet.

Specified by:

protocol in interface NeighbourMessageContext

Returns:

protocol

type

public NeighbourMessageType type()

Description copied from interface: NeighbourMessageContext

Gets the message type of the packet.

Specified by:

type in interface NeighbourMessageContext

Returns:

message type

vlan

public org.onlab.packet.VlanId vlan()

Description copied from interface: NeighbourMessageContext

Gets the vlan of the packet, if any.

Specified by:

vlan in interface NeighbourMessageContext

Returns:

vlan

srcMac

public org.onlab.packet.MacAddress srcMac()

Description copied from interface: NeighbourMessageContext

Gets the source MAC address of the message.

Specified by:

srcMac in interface NeighbourMessageContext

Returns:

source MAC address

dstMac

public org.onlab.packet.MacAddress dstMac()

Description copied from interface: NeighbourMessageContext

Gets the destination MAC address of the message.

Only valid for reply packets, will be null for request packets.

Specified by:

dstMac in interface NeighbourMessageContext

Returns:

target MAC address

target

public org.onlab.packet.IpAddress target()

Description copied from interface: NeighbourMessageContext

Gets the target IP address of the message.

Specified by:

target in interface NeighbourMessageContext

Returns:

target IP address

sender

public org.onlab.packet.IpAddress sender()

Description copied from interface: NeighbourMessageContext

Gets the source IP address of the message.

Specified by:

sender in interface NeighbourMessageContext

Returns:

source IP address

forward

public void forward(org.onosproject.net.ConnectPoint outPort)

Description copied from interface: NeighbourMessageContext

Forwards the message to a given output port.

Specified by:

forward in interface NeighbourMessageContext

Parameters:

outPort - output port

forward

public void forward(Interface outIntf)

Description copied from interface: NeighbourMessageContext

Forwards the message to a given interface.

The message will be modified to fit the parameters of the outgoing interface. For example, if the interface has a VLAN configured, the outgoing packet will have that VLAN tag added.

Specified by:

forward in interface NeighbourMessageContext

Parameters:

outIntf - output interface

reply

public void reply(org.onlab.packet.MacAddress targetMac)

Description copied from interface: NeighbourMessageContext

Replies to the request message with a given MAC address.

Specified by:

reply in interface NeighbourMessageContext

Parameters:

targetMac - target MAC address

flood

public void flood()

Description copied from interface: NeighbourMessageContext

Floods the incoming message out all ports except the input port.

Specified by:

flood in interface NeighbourMessageContext

drop

public void drop()

Description copied from interface: NeighbourMessageContext

Drops the incoming message.

Specified by:

drop in interface NeighbourMessageContext

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

createContext

public static NeighbourMessageContext createContext(org.onlab.packet.Ethernet eth,
                                                    org.onosproject.net.ConnectPoint inPort,
                                                    NeighbourMessageActions actions)

Attempts to create a MessageContext for the given Ethernet frame. If the frame is a valid ARP or NDP request or response, a context will be created.

Parameters:

eth - input Ethernet frame

inPort - in port

actions - actions to take

Returns:

MessageContext if the packet was ARP or NDP, otherwise null