1 /*
2  * Copyright (C) 2014 The Android Open Source Project
3  *
4  * 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
7  *
8  *      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.
15  */
16 
17 #pragma once
18 
19 #include "NetdConstants.h"
20 
21 #include <set>
22 #include <string>
23 
24 namespace android::net {
25 
26 // A Network represents a collection of interfaces participating as a single administrative unit.
27 class Network {
28 public:
29     enum Type {
30         DUMMY,
31         LOCAL,
32         PHYSICAL,
33         VIRTUAL,
34     };
35 
36     // You MUST ensure that no interfaces are still assigned to this network, say by calling
37     // clearInterfaces(), before deleting it. This is because interface removal may fail. If we
38     // automatically removed interfaces in the destructor, you wouldn't know if it failed.
39     virtual ~Network();
40 
41     virtual Type getType() const = 0;
42     unsigned getNetId() const;
43 
44     bool hasInterface(const std::string& interface) const;
45     const std::set<std::string>& getInterfaces() const;
46 
47     // These return 0 on success or negative errno on failure.
48     [[nodiscard]] virtual int addInterface(const std::string& interface) = 0;
49     [[nodiscard]] virtual int removeInterface(const std::string& interface) = 0;
50     [[nodiscard]] int clearInterfaces();
51 
52     std::string toString() const;
53 
54 protected:
55     explicit Network(unsigned netId);
56 
57     const unsigned mNetId;
58     std::set<std::string> mInterfaces;
59 };
60 
61 }  // namespace android::net
62