dns_utils.hpp File Reference

#include "common/types.hpp"

Go to the source code of this file.

Classes
struct	DnsNameInfo

Functions
DnsNameInfo	SplitFullDnsName (const std::string &aName)
otbrError	SplitFullServiceName (const std::string &aFullName, std::string &aType, std::string &aDomain)
otbrError	SplitFullServiceInstanceName (const std::string &aFullName, std::string &aInstanceName, std::string &aType, std::string &aDomain)
otbrError	SplitFullHostName (const std::string &aFullName, std::string &aHostName, std::string &aDomain)

Detailed Description

This file includes DNS utilities.

Function Documentation

SplitFullDnsName()

DnsNameInfo SplitFullDnsName

(

const std::string &

aName

)

This method splits a full DNS name into name components.

Parameters

[in]

aName

The full DNS name to dissect.

Returns

A DnsNameInfo structure containing DNS name information.

See also

DnsNameInfo

SplitFullHostName()

otbrError SplitFullHostName	(	const std::string &	aFullName,
		std::string &	aHostName,
		std::string &	aDomain
	)

This function splits a full host name into components.

Parameters

[in]	aFullName	The full host name to split.
[out]	aHostName	A reference to a string to receive the host name.
[out]	aDomain	A reference to a string to receive the domain.

Return values

OTBR_ERROR_NONE	Successfully split the full host name.
OTBR_ERROR_INVALID_ARGS	If the full host name is not valid.

SplitFullServiceInstanceName()

otbrError SplitFullServiceInstanceName	(	const std::string &	aFullName,
		std::string &	aInstanceName,
		std::string &	aType,
		std::string &	aDomain
	)

This function splits a full service instance name into components.

Parameters

[in]	aFullName	The full service instance name to split.
[out]	aInstanceName	A reference to a string to receive the instance name.
[out]	aType	A reference to a string to receive the service type.
[out]	aDomain	A reference to a string to receive the domain.

Return values

OTBR_ERROR_NONE	Successfully split the full service instance name.
OTBR_ERROR_INVALID_ARGS	If the full service instance name is not valid.

SplitFullServiceName()

otbrError SplitFullServiceName	(	const std::string &	aFullName,
		std::string &	aType,
		std::string &	aDomain
	)

This function splits a full service name into components.

Parameters

[in]	aFullName	The full service name to split.
[out]	aType	A reference to a string to receive the service type.
[out]	aDomain	A reference to a string to receive the domain.

Return values

OTBR_ERROR_NONE	Successfully split the full service name.
OTBR_ERROR_INVALID_ARGS	If the full service name is not valid.