Adding vxlan tunnel id alocator interface.
[honeycomb.git] / vbd / api / src / main / java / io.fd.honeycomb.vbd.api / VxlanTunnelIdAlocator.java
diff --git a/vbd/api/src/main/java/io.fd.honeycomb.vbd.api/VxlanTunnelIdAlocator.java b/vbd/api/src/main/java/io.fd.honeycomb.vbd.api/VxlanTunnelIdAlocator.java
new file mode 100644 (file)
index 0000000..58c7e38
--- /dev/null
@@ -0,0 +1,23 @@
+/**
+ * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
+ * <p>
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package io.fd.honeycomb.vbd.api;
+
+
+import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
+
+
+public interface VxlanTunnelIdAlocator {
+
+    /**
+     * Allocate next available vxlan tunnel ID
+     *
+     * @param vpp specify contret vpp for which is next available vxlan id looked for
+     * @return next available (in order) vxlan id.
+     */
+    Integer nextIdFor(final NodeId vpp);
+}