Network Services API  2.20.00.11
slnetutils.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-2018, Texas Instruments Incorporated
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
7  * are met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  *
16  * * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*****************************************************************************/
34 /* Include files */
35 /*****************************************************************************/
36 
37 #ifndef __SL_NET_UTILS_H__
38 #define __SL_NET_UTILS_H__
39 
40 #include "slnetsock.h"
41 
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
59 /*****************************************************************************/
60 /* Structure/Enum declarations */
61 /*****************************************************************************/
62 
63 /* Creating one address parameter from 4 separate address parameters */
64 #define SLNETUTIL_IPV4_VAL(add_3,add_2,add_1,add_0) ((((uint32_t)add_3 << 24) & 0xFF000000) | (((uint32_t)add_2 << 16) & 0xFF0000) | (((uint32_t)add_1 << 8) & 0xFF00) | ((uint32_t)add_0 & 0xFF) )
65 
66 /*****************************************************************************/
67 /* Function prototypes */
68 /*****************************************************************************/
69 
78 int32_t SlNetUtil_init(int32_t flags);
79 
147 int32_t SlNetUtil_getHostByName(uint32_t ifBitmap, char *name, const uint16_t nameLen, uint32_t *ipAddr, uint16_t *ipAddrLen, const uint8_t family);
148 
149 
167 uint32_t SlNetUtil_htonl(uint32_t val);
168 
169 
187 uint32_t SlNetUtil_ntohl(uint32_t val);
188 
189 
207 uint16_t SlNetUtil_htons(uint16_t val);
208 
209 
227 uint16_t SlNetUtil_ntohs(uint16_t val);
228 
229 
267 const char *SlNetUtil_inetNtop(int16_t addrFamily, const void *binaryAddr, char *strAddr, SlNetSocklen_t strAddrLen);
268 
269 
301 int32_t SlNetUtil_inetPton(int16_t addrFamily, const char *strAddr, void *binaryAddr);
302 
311 #ifdef __cplusplus
312 }
313 #endif /* __cplusplus */
314 
315 #endif /* __SL_NET_UTILS_H__ */
const char * SlNetUtil_inetNtop(int16_t addrFamily, const void *binaryAddr, char *strAddr, SlNetSocklen_t strAddrLen)
Converts IP address in binary representation to string representation.
uint16_t SlNetSocklen_t
The SlNetSocklen_t is used for declaring the socket length parameter.
Definition: slnetsock.h:583
uint16_t SlNetUtil_htons(uint16_t val)
Reorder the bytes of a 16-bit unsigned value.
int32_t SlNetUtil_getHostByName(uint32_t ifBitmap, char *name, const uint16_t nameLen, uint32_t *ipAddr, uint16_t *ipAddrLen, const uint8_t family)
Get host IP by name Obtain the IP Address of machine on network, by machine name. ...
int32_t SlNetUtil_inetPton(int16_t addrFamily, const char *strAddr, void *binaryAddr)
Converts IP address in string representation to binary representation.
uint32_t SlNetUtil_ntohl(uint32_t val)
Reorder the bytes of a 32-bit unsigned value.
int32_t SlNetUtil_init(int32_t flags)
Initialize the SlNetUtil module.
uint32_t SlNetUtil_htonl(uint32_t val)
Reorder the bytes of a 32-bit unsigned value.
uint16_t SlNetUtil_ntohs(uint16_t val)
Reorder the bytes of a 16-bit unsigned value.
Copyright 2018, Texas Instruments Incorporated