Sergey Pastor / 1

Dependents:   Nucleo

Embed: (wiki syntax)

« Back to documentation index

tcp_timer.h File Reference
Functions

tcp_timer.h File Reference

TCP timer management. More...

Go to the source code of this file.

Functions

void tcpTick (void)
 TCP timer handler.
void tcpTimerStart (TcpTimer *timer, systime_t delay)
 Start TCP timer.
void tcpTimerStop (TcpTimer *timer)
 Stop TCP timer.
bool_t tcpTimerRunning (TcpTimer *timer)
 Check whether a TCP timer is running.
bool_t tcpTimerElapsed (TcpTimer *timer)
 Check whether a TCP timer has elapsed.
systime_t tcpTimerGetInterval (TcpTimer *timer)
 Get current time interval.

Detailed Description

TCP timer management.

License

Copyright (C) 2010-2017 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

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 the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author:
Oryx Embedded SARL (www.oryx-embedded.com)
Version:
1.7.6

Definition in file tcp_timer.h.

Function Documentation

void tcpTick ( void   )

TCP timer handler.

This routine must be periodically called by the TCP/IP stack to handle retransmissions and TCP related timers (persist timer, FIN-WAIT-2 timer and TIME-WAIT timer)

Definition at line 56 of file tcp_timer.c.

bool_t tcpTimerElapsed ( TcpTimer *  timer )

Check whether a TCP timer has elapsed.

Parameters:
[in]timerPointer to the timer structure
Returns:
Timer state

Definition at line 314 of file tcp_timer.c.

systime_t tcpTimerGetInterval ( TcpTimer *  timer )

Get current time interval.

Parameters:
[in]timerPointer to the timer structure
Returns:
Current time interval

Definition at line 339 of file tcp_timer.c.

bool_t tcpTimerRunning ( TcpTimer *  timer )

Check whether a TCP timer is running.

Parameters:
[in]timerPointer to the timer structure
Returns:
Timer state

Definition at line 301 of file tcp_timer.c.

void tcpTimerStart ( TcpTimer *  timer,
systime_t  delay 
)

Start TCP timer.

Parameters:
[in]timerPointer to the timer structure
[in]delayTime interval

Definition at line 272 of file tcp_timer.c.

void tcpTimerStop ( TcpTimer *  timer )

Stop TCP timer.

Parameters:
[in]timerPointer to the timer structure

Definition at line 288 of file tcp_timer.c.

Generated on Tue Jul 12 2022 17:10:23 by  doxygen 1.7.2