incubator-nuttx/net/socket/net_timeo.c

87 lines
3.1 KiB
C

/****************************************************************************
* net/socket/net_timeo.c
*
* Copyright (C) 2007-2009, 2011-2012, 2014 Gregory Nutt.
* All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. 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.
* 3. Neither the name NuttX 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.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#if defined(CONFIG_NET) && defined(CONFIG_NET_SOCKOPTS)
#include <stdint.h>
#include <debug.h>
#include <nuttx/clock.h>
#include "socket/socket.h"
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: net_timeo
*
* Description:
* Check if a timeout has elapsed. This can be called from a socket poll
* function to determine if a timeout has occurred.
*
* Input Parameters:
* start_time Timeout start time in system clock ticks
* timeout Timeout value in deciseconds.
*
* Returned Value:
* 0 (FALSE) if not timeout; 1 (TRUE) if timeout
*
* Assumptions:
*
****************************************************************************/
int net_timeo(clock_t start_time, socktimeo_t timeo)
{
clock_t timeo_ticks = DSEC2TICK(timeo);
clock_t elapsed = clock_systimer() - start_time;
if (elapsed >= timeo_ticks)
{
return TRUE;
}
return FALSE;
}
#endif /* CONFIG_NET && CONFIG_NET_SOCKOPTS */