blob: 462875a3ad910d75305fbea5129d533b7a651402 [file] [log] [blame]
Thomas Vachuska83e090e2014-10-22 14:25:35 -07001/*
Thomas Vachuska4f1a60c2014-10-28 13:39:07 -07002 * Copyright 2014 Open Networking Laboratory
Thomas Vachuska83e090e2014-10-22 14:25:35 -07003 *
Thomas Vachuska4f1a60c2014-10-28 13:39:07 -07004 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
Thomas Vachuska83e090e2014-10-22 14:25:35 -07007 *
Thomas Vachuska4f1a60c2014-10-28 13:39:07 -07008 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
Thomas Vachuska83e090e2014-10-22 14:25:35 -070015 */
Brian O'Connorabafb502014-12-02 22:26:20 -080016package org.onosproject.net.flow;
tom8bb16062014-09-12 14:47:46 -070017
Brian O'Connorabafb502014-12-02 22:26:20 -080018import org.onosproject.core.GroupId;
19import org.onosproject.net.DeviceId;
tom8bb16062014-09-12 14:47:46 -070020
tom8bb16062014-09-12 14:47:46 -070021/**
22 * Represents a generalized match & action pair to be applied to
Sho SHIMIZUa19a2e52014-11-17 11:08:19 -080023 * an infrastructure device.
tom8bb16062014-09-12 14:47:46 -070024 */
Sho SHIMIZU5e5d4aa2015-01-26 16:12:11 -080025public interface FlowRule {
tom8bb16062014-09-12 14:47:46 -070026
alshabibba5ac482014-10-02 17:15:20 -070027 static final int MAX_TIMEOUT = 60;
alshabiba0e04982014-10-03 13:03:19 -070028 static final int MIN_PRIORITY = 0;
alshabiba7f7ca82014-09-22 11:41:23 -070029
sangho11c30ac2015-01-22 14:30:55 -080030 /**
31 * The FlowRule type is used to determine in which table the flow rule
32 * needs to be put for multi-table support switch.
33 * For single table switch, Default is used.
34 */
35 public static enum Type {
36 /* Default type - used in flow rule for single table switch */
37 DEFAULT,
38 /* Used in flow entry for IP table */
39 IP,
40 /* Used in flow entry for MPLS table */
41 MPLS,
42 /* Used in flow entry for ACL table */
alshabib9af70072015-02-09 14:34:16 -080043 ACL,
44
45 /* VLAN-to-MPLS table */
46 VLAN_MPLS,
47
48 /* VLAN table */
49 VLAN,
50
51 /* L2 table */
52 ETHER,
53
54 /* Class of Service table */
55 COS,
sangho11c30ac2015-01-22 14:30:55 -080056 }
57
alshabib369d2942014-09-12 17:59:35 -070058 //TODO: build cookie value
Ayaka Koshibed4e53e12014-09-18 14:24:55 -070059 /**
60 * Returns the ID of this flow.
61 *
62 * @return the flow ID
63 */
64 FlowId id();
alshabib369d2942014-09-12 17:59:35 -070065
tom8bb16062014-09-12 14:47:46 -070066 /**
alshabiba68eb962014-09-24 20:34:13 -070067 * Returns the application id of this flow.
68 *
69 * @return an applicationId
70 */
alshabib92c65ad2014-10-08 21:56:05 -070071 short appId();
alshabiba68eb962014-09-24 20:34:13 -070072
73 /**
alshabib28204e52014-11-12 18:29:45 -080074 * Returns the group id of this flow.
75 *
76 * @return an groupId
77 */
Sho SHIMIZU75a5bd92014-11-25 11:22:56 -080078 GroupId groupId();
alshabib28204e52014-11-12 18:29:45 -080079
80 /**
tom8bb16062014-09-12 14:47:46 -070081 * Returns the flow rule priority given in natural order; higher numbers
82 * mean higher priorities.
83 *
84 * @return flow rule priority
85 */
86 int priority();
87
88 /**
89 * Returns the identity of the device where this rule applies.
90 *
91 * @return device identifier
92 */
93 DeviceId deviceId();
94
95 /**
96 * Returns the traffic selector that identifies what traffic this
97 * rule should apply to.
98 *
99 * @return traffic selector
100 */
101 TrafficSelector selector();
102
103 /**
104 * Returns the traffic treatment that applies to selected traffic.
105 *
106 * @return traffic treatment
107 */
alshabib369d2942014-09-12 17:59:35 -0700108 TrafficTreatment treatment();
tom8bb16062014-09-12 14:47:46 -0700109
Ayaka Koshibed4e53e12014-09-18 14:24:55 -0700110 /**
alshabibba5ac482014-10-02 17:15:20 -0700111 * Returns the timeout for this flow requested by an application.
Jonathan Hartbc4a7932014-10-21 11:46:00 -0700112 *
alshabibba5ac482014-10-02 17:15:20 -0700113 * @return integer value of the timeout
alshabib6eb438a2014-10-01 16:39:37 -0700114 */
alshabibba5ac482014-10-02 17:15:20 -0700115 int timeout();
alshabib6eb438a2014-10-01 16:39:37 -0700116
Jonathan Hartbc4a7932014-10-21 11:46:00 -0700117 /**
118 * Returns whether the flow is permanent i.e. does not time out.
119 *
120 * @return true if the flow is permanent, otherwise false
121 */
122 boolean isPermanent();
123
sangho11c30ac2015-01-22 14:30:55 -0800124 /**
125 * Returns the flow rule type.
126 *
127 * @return flow rule type
128 */
129 Type type();
130
tom8bb16062014-09-12 14:47:46 -0700131}