Sam Kumar
d79468bb18
This commit adds support for the remaining TCP callback, which was not yet supported. Originally, the unimplemented callback was otTcpSendReady, which would indicate to the application when new data added to the TCP send buffer would be sent out immediately. There was also discussion of adding an otTcpBytesAcked callback, which, together with the otTcpSendByExtension() call, would allow a circular buffer to be implemented efficiently on top of the otLinkedBuffer API. Ultimately, it seemed best to generalize the otTcpSendReady callback to include both cases where bytes are acked by the connection peer, and where the send buffer drains, allowing new data to be sent immediately. The reasoning behind this decision is that both the otTcpSendReady and otTcpBytesAcked callbacks are triggered by the same event --- an ACK received from the connection peer --- and that it may require the application to have to "coordinate state" across callbacks. Having a single callback function to indicate both conditions seemed like it could simplify applications significantly. The new, combined, callback is otTcpForwardProgress. This commit implements support and documentation for this callback function.
What is OpenThread?
OpenThread released by Google is... 
...an open-source implementation of the Thread networking protocol. Google Nest has released OpenThread to make the technology used in Nest products more broadly available to developers to accelerate the development of products for the connected home.
...OS and platform agnostic, with a narrow platform abstraction layer and a small memory footprint, making it highly portable. It supports both system-on-chip (SoC) and network co-processor (NCP) designs.
...a Thread Certified Component, implementing all features defined in the Thread 1.2 specification, including all Thread networking layers (IPv6, 6LoWPAN, IEEE 802.15.4 with MAC security, Mesh Link Establishment, Mesh Routing) and device roles, as well as Border Router support.
More information about Thread can be found at threadgroup.org. Thread is a registered trademark of the Thread Group, Inc.
Who supports OpenThread?
Getting started
All end-user documentation and guides are located at openthread.io. If you're looking to do things like...
- Learn more about OpenThread features and enhancements
- Use OpenThread in your products
- Learn how to build and configure a Thread network
- Port OpenThread to a new platform
- Build an application on top of OpenThread
- Certify a product using OpenThread
...then openthread.io is the place for you.
Note: For users in China, end-user documentation is available at openthread.google.cn.
If you're interested in contributing to OpenThread, read on.
Contributing
We would love for you to contribute to OpenThread and help make it even better than it is today! See our Contributing Guidelines for more information.
Contributors are required to abide by our Code of Conduct and Coding Conventions and Style Guide.
Versioning
OpenThread follows the Semantic Versioning guidelines for release cycle transparency and to maintain backwards compatibility. OpenThread's versioning is independent of the Thread protocol specification version but will clearly indicate which version of the specification it currently supports.
License
OpenThread is released under the BSD 3-Clause license. See the LICENSE file for more information.
Please only use the OpenThread name and marks when accurately referencing this software distribution. Do not use the marks in a way that suggests you are endorsed by or otherwise affiliated with Nest, Google, or The Thread Group.
Need help?
OpenThread support is available on GitHub:
- Bugs and feature requests — submit to the Issue Tracker
- Community Discussion - ask questions, share ideas, and engage with other community members