blob: b6ec57442a7138e2e47ea451454d8dbbfc470e47 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
/*
* Copyright 2014-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.openflow.controller;
import org.onosproject.net.Device;
import org.projectfloodlight.openflow.protocol.OFFactory;
import org.projectfloodlight.openflow.protocol.OFMessage;
import org.projectfloodlight.openflow.protocol.OFPortDesc;
import java.util.List;
/**
* Represents to provider facing side of a switch.
*/
public interface OpenFlowSwitch {
/**
* Writes the message to the driver.
* <p>
* Note: Messages may be silently dropped/lost due to IOExceptions or
* role. If this is a concern, then a caller should use barriers.
* </p>
*
* @param msg the message to write
*/
void sendMsg(OFMessage msg);
/**
* Writes the OFMessage list to the driver.
* <p>
* Note: Messages may be silently dropped/lost due to IOExceptions or
* role. If this is a concern, then a caller should use barriers.
* </p>
*
* @param msgs the messages to be written
*/
void sendMsg(List<OFMessage> msgs);
/**
* Handle a message from the switch.
* @param fromSwitch the message to handle
*/
void handleMessage(OFMessage fromSwitch);
/**
* Sets the role for this switch.
* @param role the role to set.
*/
void setRole(RoleState role);
/**
* Fetch the role for this switch.
* @return the role.
*/
RoleState getRole();
/**
* Fetches the ports of this switch.
* @return unmodifiable list of the ports.
*/
List<OFPortDesc> getPorts();
/**
* Provides the factory for this OF version.
* @return OF version specific factory.
*/
OFFactory factory();
/**
* Gets a string version of the ID for this switch.
*
* @return string version of the ID
*/
String getStringId();
/**
* Gets the datapathId of the switch.
*
* @return the switch dpid in long format
*/
long getId();
/**
* fetch the manufacturer description.
* @return the description
*/
String manufacturerDescription();
/**
* fetch the datapath description.
* @return the description
*/
String datapathDescription();
/**
* fetch the hardware description.
* @return the description
*/
String hardwareDescription();
/**
* fetch the software description.
* @return the description
*/
String softwareDescription();
/**
* fetch the serial number.
* @return the serial
*/
String serialNumber();
/**
* Checks if the switch is still connected.
*
* @return whether the switch is still connected
*/
boolean isConnected();
/**
* Disconnects the switch by closing the TCP connection. Results in a call
* to the channel handler's channelDisconnected method for cleanup
*/
void disconnectSwitch();
/**
* Notifies the controller that the device has responded to a set-role request.
*
* @param requested the role requested by the controller
* @param response the role set at the device
*/
void returnRoleReply(RoleState requested, RoleState response);
/**
* Returns the switch device type.
*
* @return device type
*/
Device.Type deviceType();
/**
* Identifies the channel used to communicate with the switch.
*
* @return string representation of the connection to the device
*/
String channelId();
}
|
