ESP-IDF
Select one of the symbols to view example projects that use it.
 
Outline
#define TCP6_EXT_HPP_
#include "openthread-core-config.h"
#include <openthread/tcp_ext.h>
#include "net/tcp6.hpp"
ot
Files
loading (1/5)...
SourceVuESP-IDF Framework and ExamplesESP-IDFcomponents/openthread/openthread/src/core/net/tcp6_ext.hpp
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/* * Copyright (c) 2022, The OpenThread Authors. * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. Neither the name of the copyright holder nor the * names of its contributors may be used to endorse or promote products * derived from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. *//* ... */ /** * @file * This file includes definitions for TCP/IPv6 socket extensions. *//* ... */ #ifndef TCP6_EXT_HPP_ #define TCP6_EXT_HPP_ #include "openthread-core-config.h" #include <openthread/tcp_ext.h> #include "net/tcp6.hpp" namespace ot { namespace Ip6 { /** * @addtogroup core-tcp-ext * * @brief * This module includes definitions for TCP/IPv6 socket extensions. * * @{ *//* ... */ /** * Represents a TCP circular send buffer. *//* ... */ class TcpCircularSendBuffer : public otTcpCircularSendBuffer { public: /** * Initializes a TCP circular send buffer. * * @sa otTcpCircularSendBufferInitialize * * @param[in] aDataBuffer A pointer to memory to use to store data in the TCP circular send buffer. * @param[in] aCapacity The capacity, in bytes, of the TCP circular send buffer, which must equal the size * of the memory pointed to by @p aDataBuffer . *//* ... */ void Initialize(void *aDataBuffer, size_t aCapacity); /** * Sends out data on a TCP endpoint, using this TCP circular send buffer to manage buffering. * * @sa otTcpCircularSendBufferWrite, particularly for guidance on how @p aEndpoint must be chosen. * * @param[in] aEndpoint The TCP endpoint on which to send out data. * @param[in] aData A pointer to data to copy into the TCP circular send buffer. * @param[in] aLength The length of the data pointed to by @p aData to copy into the TCP circular send buffer. * @param[out] aWritten Populated with the amount of data copied into the send buffer, which might be less than * @p aLength if the send buffer reaches capacity. * @param[in] aFlags Flags specifying options for this operation. * * @retval kErrorNone on success, or the error returned by the TCP endpoint on failure. *//* ... */ Error Write(Tcp::Endpoint &aEndpoint, const void *aData, size_t aLength, size_t &aWritten, uint32_t aFlags); /** * Performs circular-send-buffer-specific handling in the otTcpForwardProgress callback. * * @sa otTcpCircularSendBufferHandleForwardProgress * * @param[in] aInSendBuffer Value of @p aInSendBuffer passed to the otTcpForwardProgress() callback. *//* ... */ void HandleForwardProgress(size_t aInSendBuffer); /** * Returns the amount of free space in this TCP circular send buffer. * * @sa otTcpCircularSendBufferFreeSpace * * @return The amount of free space in the send buffer. *//* ... */ size_t GetFreeSpace(void) const; /** * Forcibly discards all data in this TCP circular send buffer. * * @sa otTcpCircularSendBufferForceDiscardAll *//* ... */ void ForceDiscardAll(void); /** * Deinitializes this TCP circular send buffer. * * @sa otTcpCircularSendBufferDeinitialize * * @retval kErrorNone Successfully deinitialized this TCP circular send buffer. * @retval kErrorFailed Failed to deinitialize the TCP circular send buffer. *//* ... */ Error Deinitialize(void); ... private: size_t GetIndex(size_t aStart, size_t aOffsetFromStart) const;... }{...}; }{...} // namespace Ip6 DefineCoreType(otTcpCircularSendBuffer, Ip6::TcpCircularSendBuffer); }{...} // namespace ot /* ... */ #endif // TCP6_HPP_
Details
Show:
from
Types: Columns: