com.hp.sdn.vni

Interface VniReservationService

public interface VniReservationService

A service for reserving and un-reserving VxLAN Network Identifiers (VNIs) or ranges of VNIs. The service is intended to provide a simple mechanism for marking VNIs that are used or intend to be used by applications so that applications do not attempt to use a VNI that is already in use.

The implementation of the service will distribute reservations across a team such that there is one global (per team of controllers) set of possible VNIs and any reservation or un-reservation is consistent across the entire team.

The implementation of the service will persist VNI reservations such that reservations are durable across restarts of a controller.

Unless otherwise stated, a NullPointerException will be thrown if a null argument is passed.

Typical use cases are:

• Reserve any available VNI with reserve() and later unreserve it with unreserve(Vni).
• Reserve a specific range of VNIs with reserve(Vni, Vni) and later unreserve it with unreserve(VniRange).
• List all current reservations with list()

Author:

Jesse Hummer

Method Summary

Modifier and Type	Method and Description
List<VniRange>	list() Returns a list of ranges of VNIs that have been reserved.
Vni	reserve() Reserves and return an available VNI.
VniRange	reserve(Vni start, Vni end) Reserves a range of VNIs, from a start point to an end point, inclusively.
void	unreserve(Vni vni) Unreserves (or frees up) a VNI.
void	unreserve(VniRange range) Unreserves (or frees up) a range of VNIs.

Method Detail

reserve

Vni reserve()
     throws VniReservationException

Reserves and return an available VNI.

Returns:

an available VNI

Throws:

VniReservationException - if there are no available VNIs to reserve

reserve

VniRange reserve(Vni start,
                 Vni end)
          throws VniReservationException

Reserves a range of VNIs, from a start point to an end point, inclusively. The end VNI must be greater than or equal to the start, which implies that a range can represent a single reserved VNI. If any part of the range of VNIs from start to end, inclusively, has already been reserved, an exception is thrown.

Parameters:

start - the starting VNI of the range to reserve

end - the ending VNI of the range to reserve

Returns:

a VniRange representing the range of VNIs that were reserved

Throws:

VniReservationException - if any part of the requested range has already been reserved

IllegalArgumentException - if the start VNI is greater than the end VNI

unreserve

void unreserve(Vni vni)

Unreserves (or frees up) a VNI.

Conversely to reserve(), when unreserving a VNI that has not previously been allocated, no checked exception is thrown. That is, it doesn't matter if the VNI requested for unreservation is currently reserved or not, we just make sure the end result is that it is unreserved.

Parameters:

vni - the VNI to un-reserve

unreserve

void unreserve(VniRange range)

Unreserves (or frees up) a range of VNIs.

Conversely to reserve(Vni, Vni), when unreserving a range of VNIs that have not previously been allocated, no checked exception is thrown. That is, it doesn't matter if the range of VNIs requested for unreservation is currently reserved or not, we just make sure the end result is that they are all unreserved.

Parameters:

range - the range of VNIs to un-reserve

list

List<VniRange> list()

Returns a list of ranges of VNIs that have been reserved. If no VNIs have been reserved, an empty list is returned.

Returns:

a list of ranges of VNIs that have been reserved.