Network.h revision e09b20aee85f1dfd8c18c3d8581ac875d939ba70 
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#ifndef NETD_SERVER_NETWORK_H
18#define NETD_SERVER_NETWORK_H
19
20#include "NetdConstants.h"
21
22#include <set>
23#include <string>
24
25// A Network represents a collection of interfaces participating as a single administrative unit.
26class Network {
27public:
28    enum Type {
29        PHYSICAL,
30        VIRTUAL,
31    };
32
33    // You MUST ensure that no interfaces are still assigned to this network, say by calling
34    // clearInterfaces(), before deleting it. This is because interface removal may fail. If we
35    // automatically removed interfaces in the destructor, you wouldn't know if it failed.
36    virtual ~Network();
37
38    virtual Type getType() const = 0;
39    unsigned getNetId() const;
40
41    bool hasInterface(const std::string& interface) const;
42
43    // These return 0 on success or negative errno on failure.
44    virtual int addInterface(const std::string& interface) WARN_UNUSED_RESULT = 0;
45    virtual int removeInterface(const std::string& interface) WARN_UNUSED_RESULT = 0;
46    int clearInterfaces() WARN_UNUSED_RESULT;
47
48protected:
49    explicit Network(unsigned netId);
50
51    const unsigned mNetId;
52    std::set<std::string> mInterfaces;
53};
54
55#endif  // NETD_SERVER_NETWORK_H
56