tcp_misc.h

Go to the documentation of this file.

/**
 * @file tcp_misc.h
 * @brief Helper functions for TCP
 *
 * @section License
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 *
 * Copyright (C) 2010-2024 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 2.4.0
 **/
 
#ifndef _TCP_MISC_H
#define _TCP_MISC_H
 
//Dependencies
#include "core/tcp.h"
 
//C++ guard
#ifdef __cplusplus
extern "C" {
#endif
 
//TCP related functions
error_t tcpSendSegment(Socket *socket, uint8_t flags, uint32_t seqNum,
   uint32_t ackNum, size_t length, bool_t addToQueue);
 
error_t tcpSendResetSegment(Socket *socket, uint32_t seqNum);
 
error_t tcpRejectSegment(NetInterface *interface,
   const IpPseudoHeader *pseudoHeader, const TcpHeader *segment, size_t length);
 
error_t tcpAddOption(TcpHeader *segment, uint8_t kind, const void *value,
   uint8_t length);
 
const TcpOption *tcpGetOption(const TcpHeader *segment, uint8_t kind);
 
uint32_t tcpGenerateInitialSeqNum(const IpAddr *localIpAddr,
   uint16_t localPort, const IpAddr *remoteIpAddr, uint16_t remotePort);
 
error_t tcpCheckSeqNum(Socket *socket, const TcpHeader *segment, size_t length);
error_t tcpCheckSyn(Socket *socket, const TcpHeader *segment, size_t length);
error_t tcpCheckAck(Socket *socket, const TcpHeader *segment, size_t length);
 
bool_t tcpIsDuplicateSyn(Socket *socket, const IpPseudoHeader *pseudoHeader,
   const TcpHeader *segment);
 
bool_t tcpIsDuplicateAck(Socket *socket, const TcpHeader *segment,
   size_t length);
 
void tcpFastRetransmit(Socket *socket);
void tcpFastRecovery(Socket *socket, const TcpHeader *segment, uint_t n);
void tcpFastLossRecovery(Socket *socket, const TcpHeader *segment);
 
void tcpProcessSegmentData(Socket *socket, const TcpHeader *segment,
   const NetBuffer *buffer, size_t offset, size_t length);
 
void tcpDeleteControlBlock(Socket *socket);
 
void tcpUpdateRetransmitQueue(Socket *socket);
void tcpFlushRetransmitQueue(Socket *socket);
 
void tcpFlushSynQueue(Socket *socket);
 
void tcpUpdateSackBlocks(Socket *socket, uint32_t *leftEdge, uint32_t *rightEdge);
void tcpUpdateSendWindow(Socket *socket, const TcpHeader *segment);
void tcpUpdateReceiveWindow(Socket *socket);
 
bool_t tcpComputeRto(Socket *socket);
error_t tcpRetransmitSegment(Socket *socket);
error_t tcpNagleAlgo(Socket *socket, uint_t flags);
 
void tcpChangeState(Socket *socket, TcpState newState);
 
void tcpUpdateEvents(Socket *socket);
uint_t tcpWaitForEvents(Socket *socket, uint_t eventMask, systime_t timeout);
 
void tcpWriteTxBuffer(Socket *socket, uint32_t seqNum,
   const uint8_t *data, size_t length);
 
error_t tcpReadTxBuffer(Socket *socket, uint32_t seqNum,
   NetBuffer *buffer, size_t length);
 
void tcpWriteRxBuffer(Socket *socket, uint32_t seqNum,
   const NetBuffer *data, size_t dataOffset, size_t length);
 
void tcpReadRxBuffer(Socket *socket, uint32_t seqNum, uint8_t *data,
   size_t length);
 
void tcpDumpHeader(const TcpHeader *segment, size_t length, uint32_t iss,
   uint32_t irs);
 
//C++ guard
#ifdef __cplusplus
}
#endif
 
#endif