Open Lighting Architecture  0.9.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
InterfacePicker.h
1 /*
2  * This library is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU Lesser General Public
4  * License as published by the Free Software Foundation; either
5  * version 2.1 of the License, or (at your option) any later version.
6  *
7  * This library is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
10  * Lesser General Public License for more details.
11  *
12  * You should have received a copy of the GNU Lesser General Public
13  * License along with this library; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15  *
16  * InterfacePicker.h
17  * Choose an interface to listen on
18  * Copyright (C) 2005 Simon Newton
19  */
20 
21 #ifndef INCLUDE_OLA_NETWORK_INTERFACEPICKER_H_
22 #define INCLUDE_OLA_NETWORK_INTERFACEPICKER_H_
23 
24 #include <ola/network/Interface.h>
25 #include <string>
26 #include <vector>
27 
28 namespace ola {
29 namespace network {
30 
31 
49  public:
50  struct Options {
51  public:
52  // Include the loopback interface when searching
53  bool include_loopback;
54 
60 
61  Options()
62  : include_loopback(false),
63  specific_only(false) {
64  }
65  };
66 
71 
75  virtual ~InterfacePicker() {}
76 
77  // stupid windows, 'interface' seems to be a struct so we use iface here.
78  bool ChooseInterface(
79  Interface *iface,
80  const std::string &ip_or_name,
81  const Options &options = Options()) const;
82  bool ChooseInterface(
83  Interface *iface,
84  int32_t index,
85  const Options &options = Options()) const;
86 
87  virtual std::vector<Interface> GetInterfaces(bool include_loopback) const = 0;
88 
89  static InterfacePicker *NewPicker();
90 };
94 } // namespace network
95 } // namespace ola
96 #endif // INCLUDE_OLA_NETWORK_INTERFACEPICKER_H_
97