Package org.onosproject.net.neighbour

Interface NeighbourResolutionService

public interface NeighbourResolutionService

Provides a means of registering logic for handling neighbour messages.

Method Summary

Modifier and Type	Method	Description
java.util.Map<ConnectPoint,java.util.Collection<NeighbourHandlerRegistration>>	getHandlerRegistrations()	Gets the neighbour message handlers that have been registered with the service.
void	registerNeighbourHandler(ConnectPoint connectPoint, NeighbourMessageHandler handler, ApplicationId appId)	Registers a neighbour message handler for all neighbour messages incoming on the given connect point.
void	registerNeighbourHandler(Interface intf, NeighbourMessageHandler handler, ApplicationId appId)	Registers a neighbour message handler for all neighbour messages incoming on the given interface.
void	unregisterNeighbourHandler(ConnectPoint connectPoint, NeighbourMessageHandler handler, ApplicationId appId)	Unregisters a neighbour message handler that was assigned to a connect point.
void	unregisterNeighbourHandler(Interface intf, NeighbourMessageHandler handler, ApplicationId appId)	Unregisters a neighbour message handler that was assigned to an interface.
void	unregisterNeighbourHandlers(ApplicationId appId)	Unregisters all neighbour handlers that were registered by the given application.

Method Detail

registerNeighbourHandler

void registerNeighbourHandler(ConnectPoint connectPoint,
                              NeighbourMessageHandler handler,
                              ApplicationId appId)

Registers a neighbour message handler for all neighbour messages incoming on the given connect point.

Parameters:

connectPoint - connect point

handler - neighbour message handler

appId - application ID

registerNeighbourHandler

void registerNeighbourHandler(Interface intf,
                              NeighbourMessageHandler handler,
                              ApplicationId appId)

Registers a neighbour message handler for all neighbour messages incoming on the given interface. Neighbour packets must match the fields of the interface in order to be handled by this message handler.

Parameters:

intf - interface

handler - neighbour message handler

appId - application ID

unregisterNeighbourHandler

void unregisterNeighbourHandler(ConnectPoint connectPoint,
                                NeighbourMessageHandler handler,
                                ApplicationId appId)

Unregisters a neighbour message handler that was assigned to a connect point.

Parameters:

connectPoint - connect point

handler - neighbour message handler

appId - application ID

unregisterNeighbourHandler

void unregisterNeighbourHandler(Interface intf,
                                NeighbourMessageHandler handler,
                                ApplicationId appId)

Unregisters a neighbour message handler that was assigned to an interface.

Parameters:

intf - interface

handler - neighbour message handler

appId - application ID

unregisterNeighbourHandlers

void unregisterNeighbourHandlers(ApplicationId appId)

Unregisters all neighbour handlers that were registered by the given application.

Parameters:

appId - application ID

getHandlerRegistrations

java.util.Map<ConnectPoint,java.util.Collection<NeighbourHandlerRegistration>> getHandlerRegistrations()

Gets the neighbour message handlers that have been registered with the service.

Returns:

neighbour message handlers indexed by connect point