1 /*
2  * This file is part of PowerDNS or dnsdist.
3  * Copyright -- PowerDNS.COM B.V. and its contributors
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of version 2 of the GNU General Public License as
7  * published by the Free Software Foundation.
8  *
9  * In addition, for the avoidance of any doubt, permission is granted to
10  * link this program with OpenSSL and to (re)distribute the binaries
11  * produced as the result of such linking.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21  */
22 #pragma once
23 
24 #include "iputils.hh"
25 
26 namespace pdns {
27   /*! pick a random query local address for family
28    *
29    * Will always return a ComboAddress.
30    *
31    * @param family Address Family, only AF_INET and AF_INET6 are supported
32    * @param port   Port to set in the returned ComboAddress
33    */
34   ComboAddress getQueryLocalAddress(const sa_family_t family, const in_port_t port);
35 
36   /*! Returns a non-Any address QLA, or an empty QLA when the QLA is any
37    *
38    * @param family  Address Family
39    */
40   ComboAddress getNonAnyQueryLocalAddress(const sa_family_t family);
41 
42   /*! Populate the query local address vectors
43    *
44    * Will throw when an address can't be parsed
45    *
46    * @param qla  A string of one or more ip addresses, separated by
47    *             spaces, semi-colons or commas
48    */
49   void parseQueryLocalAddress(const std::string &qla);
50 
51   /*! Is the address family explicitly enabled
52    *
53    * i.e. was there an address parsed by parseQueryLocalAddress belonging
54    * to this family
55    *
56    * @param family  Address Family, only AF_INET and AF_INET6 are supported
57    */
58   bool isQueryLocalAddressFamilyEnabled(const sa_family_t family);
59 } // namespace pdns
60