openthread-br  0.3.0-72c0388
dns_utils.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2021, The OpenThread Authors.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  * 1. Redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution.
12  * 3. Neither the name of the copyright holder nor the
13  * names of its contributors may be used to endorse or promote products
14  * derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  */
28 
34 #ifndef OTBR_COMMON_DNS_UTILS_HPP_
35 #define OTBR_COMMON_DNS_UTILS_HPP_
36 
37 #include "common/types.hpp"
38 
46 {
47  std::string mInstanceName;
48  std::string mServiceName;
49  std::string mHostName;
50  std::string mDomain;
51 
58  bool IsServiceInstance(void) const { return !mInstanceName.empty(); };
59 
66  bool IsService(void) const { return !mServiceName.empty() && mInstanceName.empty(); }
67 
74  bool IsHost(void) const { return mServiceName.empty(); }
75 };
76 
87 DnsNameInfo SplitFullDnsName(const std::string &aName);
88 
100 otbrError SplitFullServiceName(const std::string &aFullName, std::string &aType, std::string &aDomain);
101 
114 otbrError SplitFullServiceInstanceName(const std::string &aFullName,
115  std::string & aInstanceName,
116  std::string & aType,
117  std::string & aDomain);
118 
130 otbrError SplitFullHostName(const std::string &aFullName, std::string &aHostName, std::string &aDomain);
131 
132 #endif // OTBR_COMMON_DNS_UTILS_HPP_
SplitFullDnsName
DnsNameInfo SplitFullDnsName(const std::string &aName)
Definition: dns_utils.cpp:40
DnsNameInfo::IsHost
bool IsHost(void) const
Definition: dns_utils.hpp:74
DnsNameInfo::mHostName
std::string mHostName
Host name, or empty if the DNS name is not a host name.
Definition: dns_utils.hpp:49
DnsNameInfo::mDomain
std::string mDomain
Domain name.
Definition: dns_utils.hpp:50
SplitFullServiceName
otbrError SplitFullServiceName(const std::string &aFullName, std::string &aType, std::string &aDomain)
Definition: dns_utils.cpp:115
SplitFullHostName
otbrError SplitFullHostName(const std::string &aFullName, std::string &aHostName, std::string &aDomain)
Definition: dns_utils.cpp:129
DnsNameInfo::IsServiceInstance
bool IsServiceInstance(void) const
Definition: dns_utils.hpp:58
DnsNameInfo
Definition: dns_utils.hpp:45
SplitFullServiceInstanceName
otbrError SplitFullServiceInstanceName(const std::string &aFullName, std::string &aInstanceName, std::string &aType, std::string &aDomain)
Definition: dns_utils.cpp:97
otbrError
otbrError
Definition: types.hpp:70
DnsNameInfo::mInstanceName
std::string mInstanceName
Instance name, or empty if the DNS name is not a service instance.
Definition: dns_utils.hpp:47
DnsNameInfo::mServiceName
std::string mServiceName
Service name, or empty if the DNS name is not a service or service instance.
Definition: dns_utils.hpp:48
DnsNameInfo::IsService
bool IsService(void) const
Definition: dns_utils.hpp:66