tcp_timer.h
Go to the documentation of this file.
1 /**
2  * @file tcp_timer.h
3  * @brief TCP timer management
4  *
5  * @section License
6  *
7  * Copyright (C) 2010-2018 Oryx Embedded SARL. All rights reserved.
8  *
9  * This file is part of CycloneTCP Open.
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License
13  * as published by the Free Software Foundation; either version 2
14  * of the License, or (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24  *
25  * @author Oryx Embedded SARL (www.oryx-embedded.com)
26  * @version 1.9.0
27  **/
28 
29 #ifndef _TCP_TIMER_H
30 #define _TCP_TIMER_H
31 
32 //C++ guard
33 #ifdef __cplusplus
34  extern "C" {
35 #endif
36 
37 //TCP timer related functions
38 void tcpTick(void);
39 
40 void tcpTimerStart(TcpTimer *timer, systime_t delay);
41 void tcpTimerStop(TcpTimer *timer);
42 
45 
47 
48 //C++ guard
49 #ifdef __cplusplus
50  }
51 #endif
52 
53 #endif
uint32_t systime_t
Definition: compiler_port.h:44
void tcpTimerStop(TcpTimer *timer)
Stop TCP timer.
Definition: tcp_timer.c:288
bool_t tcpTimerElapsed(TcpTimer *timer)
Check whether a TCP timer has elapsed.
Definition: tcp_timer.c:314
void tcpTimerStart(TcpTimer *timer, systime_t delay)
Start TCP timer.
Definition: tcp_timer.c:272
bool_t tcpTimerRunning(TcpTimer *timer)
Check whether a TCP timer is running.
Definition: tcp_timer.c:301
TCP timer.
Definition: tcp.h:344
void tcpTick(void)
TCP timer handler.
Definition: tcp_timer.c:56
systime_t tcpTimerGetInterval(TcpTimer *timer)
Get current time interval.
Definition: tcp_timer.c:339
int bool_t
Definition: compiler_port.h:47