org.onosproject.net.packet

Interface PacketService

public interface PacketService

Service for intercepting data plane packets and for emitting synthetic outbound packets.

Method Summary

Modifier and Type	Method and Description
void	addProcessor(PacketProcessor processor, int priority) Adds the specified processor to the list of packet processors.
void	emit(OutboundPacket packet) Emits the specified outbound packet onto the network.
void	removeProcessor(PacketProcessor processor) Removes the specified processor from the processing pipeline.
void	requestPackets(TrafficSelector selector, PacketPriority priority, ApplicationId appId) Requests that packets matching the given selector are punted from the dataplane to the controller.
void	requestPackets(TrafficSelector selector, PacketPriority priority, ApplicationId appId, FlowRule.Type tableType) Requests that packets matching the given selector are punted from the dataplane to the controller.

Method Detail

addProcessor

void addProcessor(PacketProcessor processor,
                  int priority)

Adds the specified processor to the list of packet processors. It will be added into the list in the order of priority. The higher numbers will be processing the packets after the lower numbers.

Parameters:

processor - processor to be added

priority - priority in the reverse natural order

Throws:

IllegalArgumentException - if a processor with the given priority already exists

removeProcessor

void removeProcessor(PacketProcessor processor)

Removes the specified processor from the processing pipeline.

Parameters:

processor - packet processor

requestPackets

void requestPackets(TrafficSelector selector,
                    PacketPriority priority,
                    ApplicationId appId)

Requests that packets matching the given selector are punted from the dataplane to the controller.

Parameters:

selector - the traffic selector used to match packets

priority - the priority of the rule

appId - the application ID of the requester

requestPackets

void requestPackets(TrafficSelector selector,
                    PacketPriority priority,
                    ApplicationId appId,
                    FlowRule.Type tableType)

Requests that packets matching the given selector are punted from the dataplane to the controller. Clients of the PacketService should use this call to hint at the tableType in the dataplane valid for the selector.

Parameters:

selector - the traffic selector used to match packets

priority - the priority of the rule

appId - the application ID of the requester

tableType - the abstract table Type in the dataplane where flowrules should be inserted to punt the selector packets to the control plane

emit

void emit(OutboundPacket packet)

Emits the specified outbound packet onto the network.

Parameters:

packet - outbound packet