Open Lighting Architecture  0.9.0
 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15  *
16  * InterfacePicker.h
17  * Choose an interface to listen on
18  * Copyright (C) 2005-2014 Simon Newton
19  */
20 
21 #ifndef INCLUDE_OLA_NETWORK_INTERFACEPICKER_H_
22 #define INCLUDE_OLA_NETWORK_INTERFACEPICKER_H_
23 
24 #ifdef WIN32
25 #include <winsock2.h>
26 #else
27 #include <netinet/in.h>
28 #endif
29 
30 #include <ola/network/Interface.h>
31 #include <string>
32 #include <vector>
33 
34 namespace ola {
35 namespace network {
36 
37 
55  public:
56  struct Options {
57  public:
58  // Include the loopback interface when searching
59  bool include_loopback;
60 
66 
67  Options()
68  : include_loopback(false),
69  specific_only(false) {
70  }
71  };
72 
77 
81  virtual ~InterfacePicker() {}
82 
83  // stupid windows, 'interface' seems to be a struct so we use iface here.
84  bool ChooseInterface(
85  Interface *iface,
86  const std::string &ip_or_name,
87  const Options &options = Options()) const;
88  bool ChooseInterface(
89  Interface *iface,
90  int32_t index,
91  const Options &options = Options()) const;
92 
93  virtual std::vector<Interface> GetInterfaces(bool include_loopback) const = 0;
94 
95  static InterfacePicker *NewPicker();
96 };
100 } // namespace network
101 } // namespace ola
102 #endif // INCLUDE_OLA_NETWORK_INTERFACEPICKER_H_
103