aboutsummaryrefslogtreecommitdiff
path: root/platform/api/network_interface.h
blob: f0e53e17b116259b8748f5df9013ad699ff1dd7a (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
// Copyright 2018 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef PLATFORM_API_NETWORK_INTERFACE_H_
#define PLATFORM_API_NETWORK_INTERFACE_H_

#include <vector>

#include "platform/base/interface_info.h"

namespace openscreen {
namespace platform {

// Returns an InterfaceInfo for each currently active network interface on the
// system. No two entries in this vector can have the same NetworkInterfaceIndex
// value.
//
// This can return an empty vector if: 1) there are no active network
// interfaces, 2) an error occurred querying the system for them, or 3) Open
// Screen features that involve broadcast listening/publishing (e.g., mDNS
// discovery) are not being used.
std::vector<InterfaceInfo> GetNetworkInterfaces();

}  // namespace platform
}  // namespace openscreen

#endif  // PLATFORM_API_NETWORK_INTERFACE_H_