slnetconn.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019-2020, 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_CONN_H__
#define __SL_NET_CONN_H__

#include <stdint.h>
#include <stdbool.h>

#include <ti/net/slnetsock.h>
#include <ti/net/slnetutils.h>
#include <ti/net/slneterr.h>


#ifdef    __cplusplus
extern "C" {
#endif


/*****************************************************************************/
/* Macro declarations                                                        */
/*****************************************************************************/

/* Maximum number of NetIf supported */
#define SLNETCONN_NETWORK_INTERFACES_NUM    2

/* Maximum number of Users supported */
#define SLNETCONN_USERS_NUM                 8

/* Enable/Disable Module's Logs
 * Registration of a debug print callback will be required when enable
 *
 * \sa - SlNetConn_registerDebugCallback */
#define SLNETCONN_DEBUG_ENABLE              (0)

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

typedef enum
{
    SLNETCONN_SERVICE_LVL_MAC                = 0,
    SLNETCONN_SERVICE_LVL_IP                 = 1,
    SLNETCONN_SERVICE_LVL_INTERNET           = 2
} SlNetConnServiceLevel_e;

/* Note: SLNETCONN_STATUS_CONNECTED serves as a baseline for the CONNECTED statuses.
 * It is equal to SLNETCONN_STATUS_CONNECTED_MAC (as SLNETCONN_SERVICE_LVL_MAC = 0).
 * Note: Internet Connection is not maintained - it will be checked only upon the first
 *       connection, but the system will not identify if the access-point loses the Internet access.
 *       Users may check the connection periodically using SlNetConn_getStatus() (with
 *       bCheckInternetConnection set to true).
 *       User can also use socket error indication as the trigger for Internet access check.
 */
typedef enum
{
    SLNETCONN_STATUS_DISCONNECTED            = 1,
    SLNETCONN_STATUS_WAITING_FOR_CONNECTION  = 2,
    SLNETCONN_STATUS_CONNECTED               = 3,
    SLNETCONN_STATUS_CONNECTED_MAC           = SLNETCONN_STATUS_CONNECTED + SLNETCONN_SERVICE_LVL_MAC,
    SLNETCONN_STATUS_CONNECTED_IP            = SLNETCONN_STATUS_CONNECTED + SLNETCONN_SERVICE_LVL_IP,
    SLNETCONN_STATUS_CONNECTED_INTERNET      = SLNETCONN_STATUS_CONNECTED + SLNETCONN_SERVICE_LVL_INTERNET,
} SlNetConnStatus_e;



typedef void (*SlNetConn_AppEvent_f)(uint32_t ifID, SlNetConnStatus_e netStatus, void* data);

typedef struct SlNetConn_config_t
{
    uint32_t ifBitmap;          
    char *pServerAddress;       
    uint16_t serverAddrFamily;  
} SlNetConn_config_t;


typedef void (*SlNetConn_Debug_f)(const char *  _format, ...);

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

int32_t SlNetConn_init(int32_t flags);

int32_t SlNetConn_setConfiguration(SlNetConn_config_t *pConf);


int32_t SlNetConn_start(SlNetConnServiceLevel_e targetServiceLevel, SlNetConn_AppEvent_f fAppEventHdl,
                        uint32_t timeout, uint32_t flags);


int32_t SlNetConn_stop(SlNetConn_AppEvent_f fAppEventHdl);


int32_t SlNetConn_waitForConnection(SlNetConnServiceLevel_e targetServiceLevel, uint32_t timeout);

int32_t SlNetConn_getStatus(bool bCheckInternetConnection, SlNetConnStatus_e *pStatus);

void *SlNetConn_process(void* pvParameters);

#if SLNETCONN_DEBUG_ENABLE

void SlNetConn_registerDebugCallback(SlNetConn_Debug_f fDebugPrint);
#endif

#ifdef  __cplusplus
}
#endif /* __cplusplus */

#endif /* __NET_CONN_H__ */