diff options
Diffstat (limited to 'include/iprt/cidr.h')
-rw-r--r-- | include/iprt/cidr.h | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/include/iprt/cidr.h b/include/iprt/cidr.h new file mode 100644 index 00000000..ed9d558d --- /dev/null +++ b/include/iprt/cidr.h @@ -0,0 +1,76 @@ +/** @file + * IPRT - TCP/IP. + */ + +/* + * Copyright (C) 2008-2022 Oracle and/or its affiliates. + * + * This file is part of VirtualBox base platform packages, as + * available from https://www.virtualbox.org. + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation, in version 3 of the + * License. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, see <https://www.gnu.org/licenses>. + * + * The contents of this file may alternatively be used under the terms + * of the Common Development and Distribution License Version 1.0 + * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included + * in the VirtualBox distribution, in which case the provisions of the + * CDDL are applicable instead of those of the GPL. + * + * You may elect to license modified versions of this file under the + * terms and conditions of either the GPL or the CDDL or both. + * + * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0 + */ + +#ifndef IPRT_INCLUDED_cidr_h +#define IPRT_INCLUDED_cidr_h +#ifndef RT_WITHOUT_PRAGMA_ONCE +# pragma once +#endif + +#include <iprt/cdefs.h> +#include <iprt/types.h> +#include <iprt/net.h> + +/** @defgroup grp_rt_cidr RTCidr - Classless Inter-Domain Routing notation + * @ingroup grp_rt + * @{ + */ +RT_C_DECLS_BEGIN + +/** + * Parse a string which contains an IP address in CIDR (Classless + * Inter-Domain Routing) notation. + * + * @warning The network address and the network mask are returned in + * @b host(!) byte order. This is different from all the other + * RTNetStrTo* functions. + * + * @deprecated This function is superseded by RTNetStrToIPv4Cidr() + * that provides a better API consistent with other functions + * from that family. It returns the prefix length, if you need a + * netmask, you can obtain it with RTNetPrefixToMaskIPv4(). + * + * @return iprt status code. + * + * @param pszAddress The IP address in CIDR specificaion. + * @param pNetwork The determined IP address / network in host byte order. + * @param pNetmask The determined netmask in host byte order. + */ +RTDECL(int) RTCidrStrToIPv4(const char *pszAddress, PRTNETADDRIPV4 pNetwork, PRTNETADDRIPV4 pNetmask); + +RT_C_DECLS_END +/** @} */ + +#endif /* !IPRT_INCLUDED_cidr_h */ |