aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/onos/core/api/src/main/java/org/onosproject/net/packet
diff options
context:
space:
mode:
Diffstat (limited to 'framework/src/onos/core/api/src/main/java/org/onosproject/net/packet')
-rw-r--r--framework/src/onos/core/api/src/main/java/org/onosproject/net/packet/PacketProcessorEntry.java58
-rw-r--r--framework/src/onos/core/api/src/main/java/org/onosproject/net/packet/PacketService.java8
-rw-r--r--framework/src/onos/core/api/src/main/java/org/onosproject/net/packet/PacketStore.java6
-rw-r--r--framework/src/onos/core/api/src/main/java/org/onosproject/net/packet/PacketStoreDelegate.java16
4 files changed, 79 insertions, 9 deletions
diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/net/packet/PacketProcessorEntry.java b/framework/src/onos/core/api/src/main/java/org/onosproject/net/packet/PacketProcessorEntry.java
new file mode 100644
index 00000000..40386fb7
--- /dev/null
+++ b/framework/src/onos/core/api/src/main/java/org/onosproject/net/packet/PacketProcessorEntry.java
@@ -0,0 +1,58 @@
+/*
+ * Copyright 2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.net.packet;
+
+/**
+ * Packet processor entry tracking the processor, its priority and
+ * time consumption.
+ */
+public interface PacketProcessorEntry {
+
+ /**
+ * Returns the packet processor.
+ *
+ * @return packet processor
+ */
+ PacketProcessor processor();
+
+ /**
+ * Returns the packet processor priority.
+ *
+ * @return processor priority
+ */
+ int priority();
+
+ /**
+ * Returns the number of invocations.
+ *
+ * @return number of invocations
+ */
+ long invocations();
+
+ /**
+ * Returns the total time, in nanoseconds, spent processing packets.
+ *
+ * @return total time in nanos
+ */
+ long totalNanos();
+
+ /**
+ * Returns the average time, in nanoseconds, spent processing packets.
+ *
+ * @return average time in nanos
+ */
+ long averageNanos();
+}
diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/net/packet/PacketService.java b/framework/src/onos/core/api/src/main/java/org/onosproject/net/packet/PacketService.java
index 98f4d8e0..2e7a1b91 100644
--- a/framework/src/onos/core/api/src/main/java/org/onosproject/net/packet/PacketService.java
+++ b/framework/src/onos/core/api/src/main/java/org/onosproject/net/packet/PacketService.java
@@ -20,7 +20,6 @@ import org.onosproject.core.ApplicationId;
import org.onosproject.net.flow.TrafficSelector;
import java.util.List;
-import java.util.Map;
/**
* Service for intercepting data plane packets and for emitting synthetic
@@ -52,13 +51,12 @@ public interface PacketService {
void removeProcessor(PacketProcessor processor);
/**
- * Returns priority bindings of all registered packet processors.
+ * Returns priority bindings of all registered packet processor entries.
*
- * @return list of existing packet processors
+ * @return list of existing packet processor entries
*/
@Beta
- // TODO: Consider returning list of PacketProcessorEntry with processor, priority and stats
- Map<Integer, PacketProcessor> getProcessors();
+ List<PacketProcessorEntry> getProcessors();
/**
* Requests that packets matching the given selector are punted from the
diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/net/packet/PacketStore.java b/framework/src/onos/core/api/src/main/java/org/onosproject/net/packet/PacketStore.java
index 97f7cb55..d83fc9a2 100644
--- a/framework/src/onos/core/api/src/main/java/org/onosproject/net/packet/PacketStore.java
+++ b/framework/src/onos/core/api/src/main/java/org/onosproject/net/packet/PacketStore.java
@@ -37,17 +37,15 @@ public interface PacketStore extends Store<PacketEvent, PacketStoreDelegate> {
* Requests intercept of packets that match the given selector.
*
* @param request a packet request
- * @return true if the first time the given selector was requested
*/
- boolean requestPackets(PacketRequest request);
+ void requestPackets(PacketRequest request);
/**
* Cancels intercept of packets that match the given selector.
*
* @param request a packet request
- * @return true if there is no other application requesting the given selector
*/
- boolean cancelPackets(PacketRequest request);
+ void cancelPackets(PacketRequest request);
/**
* Obtains all existing requests in the system.
diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/net/packet/PacketStoreDelegate.java b/framework/src/onos/core/api/src/main/java/org/onosproject/net/packet/PacketStoreDelegate.java
index bf5c3cc0..2e59b19d 100644
--- a/framework/src/onos/core/api/src/main/java/org/onosproject/net/packet/PacketStoreDelegate.java
+++ b/framework/src/onos/core/api/src/main/java/org/onosproject/net/packet/PacketStoreDelegate.java
@@ -21,4 +21,20 @@ import org.onosproject.store.StoreDelegate;
* Packet store delegate abstraction.
*/
public interface PacketStoreDelegate extends StoreDelegate<PacketEvent> {
+
+ /**
+ * Requests that packets matching to following request be collected
+ * from all switches.
+ *
+ * @param request packet request
+ */
+ void requestPackets(PacketRequest request);
+
+ /**
+ * Requests that packets matching to following request no longer be
+ * collected from any switches.
+ *
+ * @param request packet request
+ */
+ void cancelPackets(PacketRequest request);
}