/* SPDX-License-Identifier: LGPL-2.1-only OR BSD-3-Clause */
/******************************************************************************
 *
 * This file is provided under a dual license.  When you use or
 * distribute this software, you may choose to be licensed under
 * version 2.1 of the GNU Lesser General Public License
 * ("LGPLv2.1 License") or BSD License.
 *
 * LGPLv2.1 License
 *
 * Copyright(C) 2019 MediaTek Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2.1 of the GNU Lesser General Public
 * License as published by the Free Software Foundation.
 *
 * 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 https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html for more
 * details.
 *
 * BSD LICENSE
 *
 * Copyright(C) 2019 MediaTek Inc.
 * 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 the copyright holder 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
 * HOLDER 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.
 *
 *****************************************************************************/

/*----------------------------------------------------------------------------*/
/*! @file c_net_socket.h
 * $RCSfile: $
 * $Revision: #1 $
 * $Date: 2015/05/29 $
 * $Author: brianpc.huang $
 *
 * @par Description:
 *      network socket APIs
 */
/*----------------------------------------------------------------------------*/
/*!
* @addtogroup  groupMW_INET
* @{
*/

#ifndef C_NET_SOCKET_H
#define C_NET_SOCKET_H

#include "u_net_socket.h"
#ifdef MT8520
#include "u_time.h"
#else
#include <time.h>
#endif

/**
 * c_net_socket_nonblocking
 * 
 * configure socket as nonblocking mode
 * 
 * @param sock, socket to config
 * 
 * @return int
 * 0: ok
 * -1: failed
 */
/*!
 * @brief configure socket as nonblocking mode
 * @param in sock - socket file-description to config
 * @return return the error code
 * @retval NET_OK - ok
 * @retval else   - failed
 */
int c_net_socket_nonblocking(int sock);

/**
 * c_net_socket_blocking
 * 
 * configure socket as blocking mode
 * 
 * @param sock, socket to config
 * 
 * @return int
 * 0: ok
 * -1: failed
 */
/*!
 * @brief configure socket as blocking mode
 * @param in sock - socket file-description to config
 * @return return the error code
 * @retval NET_OK - ok
 * @retval else   - failed
 */
int c_net_socket_blocking(int sock);

/**
 * c_net_get_socket_mode
 * 
 * query current socket mode
 * 
 * @param sock
 * 
 * @return int
 * 0: blocking
 * 1: nonblocking
 */
/*!
 * @brief query current socket mode
 * @param in sock - socket file-description to query
 * @return return the error code
 * @retval NET_OK - ok
 * @retval else   - failed
 */
int c_net_get_socket_mode(int sock);

/*!
 * @brief free network host database storage return by calling gethostbyname
 * @see gethostbyname
 * @param in ptr   - the host database pointer
 */
void c_net_free_hostent(struct hostent *ptr);


/* only FIONREAD */
/*!
 * @brief control a STREAMS device (socket file-description, FIONREAD only so far)
 * @param in i4_sockfd  - socket fd
 * @param in i4_cmd     - request command
 * @param in pv_data    - request data pointer
 * @return return the error code
 * @retval NET_OK    - OK
 * @retval others    - failed
 */
int c_net_ioctl(int i4_sockfd, int i4_cmd, void *pv_data);

extern int x_net_socket_nonblocking(int sock);
extern int x_net_socket_blocking(int sock);
extern int x_net_get_socket_mode(int sock);
extern void x_net_free_hostent(struct hostent *ptr);
extern int x_net_ioctl(int i4_sockfd, int i4_cmd, void *pv_data);

#endif

/*! @} */

