summaryrefslogtreecommitdiff
path: root/include/iprt/cidr.h
blob: 5e0541869ee45ce0cf27db9c311ddd493e57c947 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/** @file
 * IPRT - TCP/IP.
 */

/*
 * Copyright (C) 2008 Oracle Corporation
 *
 * This file is part of VirtualBox Open Source Edition (OSE), as
 * available from http://www.virtualbox.org. This file is free software;
 * you can redistribute it and/or modify it under the terms of the GNU
 * General Public License (GPL) as published by the Free Software
 * Foundation, in version 2 as it comes in the "COPYING" file of the
 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
 *
 * The contents of this file may alternatively be used under the terms
 * of the Common Development and Distribution License Version 1.0
 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
 * VirtualBox OSE 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.
 */


#ifndef ___iprt_ip_h
#define ___iprt_ip_h

#include <iprt/cdefs.h>
#include <iprt/types.h>

/** @defgroup grp_rt_cidr   RTCidr - Classless Inter-Domain Routing notation
 * @ingroup grp_rt
 * @{
 */
RT_C_DECLS_BEGIN

/** An IPv4 address. */
typedef uint32_t RTIPV4ADDR;
/** Pointer to an IPv4 address. */
typedef RTIPV4ADDR *PRTIPV4ADDR;
/** Pointer to a const IPv4 address. */
typedef RTIPV4ADDR const *PCRTIPV4ADDR;


/**
 * Parse a string which contains an IP address in CIDR (Classless Inter-Domain Routing) notation.
 *
 * @return iprt status code.
 *
 * @param   pszAddress  The IP address in CIDR specificaion.
 * @param   pNetwork    The determined IP address / network.
 * @param   pNetmask    The determined netmask.
 */
RTDECL(int) RTCidrStrToIPv4(const char *pszAddress, PRTIPV4ADDR pNetwork, PRTIPV4ADDR pNetmask);

RT_C_DECLS_END
/** @} */

#endif