slnetutils.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-2019, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*****************************************************************************/
/* Include files                                                             */
/*****************************************************************************/

#ifndef __SL_NET_UTILS_H__
#define __SL_NET_UTILS_H__

#include <stddef.h>

#include "slnetsock.h"

#ifdef    __cplusplus
extern "C" {
#endif

/*****************************************************************************/
/* Macro declarations                                                        */
/*****************************************************************************/
#define SLNETUTIL_AI_PASSIVE     0x00000001
#define SLNETUTIL_AI_NUMERICHOST 0x00000004

/*****************************************************************************/
/* Structure/Enum declarations                                               */
/*****************************************************************************/

typedef struct SlNetUtil_addrInfo_t {
    int                          ai_flags;
    int                          ai_family;
    int                          ai_socktype;
    int                          ai_protocol;
    size_t                       ai_addrlen;
    struct SlNetSock_Addr_t     *ai_addr;
    char                        *ai_canonname;
    struct SlNetUtil_addrInfo_t *ai_next;
} SlNetUtil_addrInfo_t;

/* Creating one address parameter from 4 separate address parameters */
#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) )

/*****************************************************************************/
/* Function prototypes                                                       */
/*****************************************************************************/

int32_t SlNetUtil_init(int32_t flags);

const char *SlNetUtil_gaiStrErr(int32_t errorCode);

int32_t SlNetUtil_getHostByName(uint32_t ifBitmap, char *name, const uint16_t nameLen, uint32_t *ipAddr, uint16_t *ipAddrLen, const uint8_t family);


int32_t SlNetUtil_getAddrInfo(uint16_t ifID, const char *node,
        const char *service, const struct SlNetUtil_addrInfo_t *hints,
        struct SlNetUtil_addrInfo_t **res);

void SlNetUtil_freeAddrInfo(struct SlNetUtil_addrInfo_t *res);

uint32_t SlNetUtil_htonl(uint32_t val);


uint32_t SlNetUtil_ntohl(uint32_t val);


uint16_t SlNetUtil_htons(uint16_t val);


uint16_t SlNetUtil_ntohs(uint16_t val);

int SlNetUtil_inetAton(const char *str, struct SlNetSock_InAddr_t *addr);

const char *SlNetUtil_inetNtop(int16_t addrFamily, const void *binaryAddr, char *strAddr, SlNetSocklen_t strAddrLen);


int32_t SlNetUtil_inetPton(int16_t addrFamily, const char *strAddr, void *binaryAddr);

#ifdef  __cplusplus
}
#endif /* __cplusplus */

#endif /* __SL_NET_UTILS_H__ */