blob: 7fee1c14dd805333cba4f5d68c800acc950af994 [file] [log] [blame]
tom8bb16062014-09-12 14:47:46 -07001package org.onlab.onos.net.flow;
2
3/**
4 * Represents a flow rule and its associated accumulated metrics.
5 */
6public interface FlowEntry extends FlowRule {
7
Ayaka Koshibe08eabaa2014-09-17 14:59:25 -07008 /**
9 * Returns the ID of this flow.
10 *
11 * @return the flow ID
12 */
Ayaka Koshibe414196d2014-09-17 13:46:43 -070013 FlowId id();
14
tom8bb16062014-09-12 14:47:46 -070015 /**
16 * Returns the number of milliseconds this flow rule has been applied.
17 *
18 * @return number of millis
19 */
20 long lifeMillis();
21
22 /**
23 * Returns the number of milliseconds this flow rule has been idle.
24 *
25 * @return number of millis
26 */
27 long idleMillis();
28
29 /**
30 * Returns the number of packets this flow rule has matched.
31 *
32 * @return number of packets
33 */
34 long packets();
35
36 /**
37 * Returns the number of bytes this flow rule has matched.
38 *
39 * @return number of bytes
40 */
41 long bytes();
42
43}