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