1 /*
2  * FreeRTOS+TCP <DEVELOPMENT BRANCH>
3  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
4  *
5  * SPDX-License-Identifier: MIT
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a copy of
8  * this software and associated documentation files (the "Software"), to deal in
9  * the Software without restriction, including without limitation the rights to
10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
11  * the Software, and to permit persons to whom the Software is furnished to do so,
12  * subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included in all
15  * copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
19  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
20  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
21  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  *
24  * http://aws.amazon.com/freertos
25  * http://www.FreeRTOS.org
26  */
27 
28 #ifndef FREERTOS_TCP_RECEPTION_H
29 #define FREERTOS_TCP_RECEPTION_H
30 
31 /* *INDENT-OFF* */
32 #ifdef __cplusplus
33     extern "C" {
34 #endif
35 /* *INDENT-ON* */
36 
37 /*
38  * Called from xProcessReceivedTCPPacket. Parse the TCP option(s) received,
39  * if present. This function returns pdFALSE if the options are not well formed.
40  */
41 BaseType_t prvCheckOptions( FreeRTOS_Socket_t * pxSocket,
42                             const NetworkBufferDescriptor_t * pxNetworkBuffer );
43 
44 /*
45  * Called from prvTCPHandleState().  Find the TCP payload data and check and
46  * return its length.
47  */
48 BaseType_t prvCheckRxData( const NetworkBufferDescriptor_t * pxNetworkBuffer,
49                            uint8_t ** ppucRecvData );
50 
51 /*
52  * Called from prvTCPHandleState().  Check if the payload data may be accepted.
53  * If so, it will be added to the socket's reception queue.
54  */
55 BaseType_t prvStoreRxData( FreeRTOS_Socket_t * pxSocket,
56                            const uint8_t * pucRecvData,
57                            NetworkBufferDescriptor_t * pxNetworkBuffer,
58                            uint32_t ulReceiveLength );
59 
60 /* *INDENT-OFF* */
61 #ifdef __cplusplus
62     } /* extern "C" */
63 #endif
64 /* *INDENT-ON* */
65 
66 #endif /* FREERTOS_TCP_RECEPTION_H */
67