Skip to content

UDP sockect doc update #296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Oct 30, 2017
Merged

UDP sockect doc update #296

Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0d2da31
Added UDP example
Oct 18, 2017
d81bc16
Copy edit UDPSocket.md
Oct 18, 2017
d9e7ab2
Changed example repo
Oct 23, 2017
612ecd7
Constructor info added
Oct 25, 2017
d5f29f4
Copy edit new addition to UDPSocket.md
Oct 26, 2017
dd69e29
Change passive to active voice.
Oct 30, 2017
b066ab6
Update UDPSocket.md
Oct 30, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/reference/api/connectivity/networksocket/UDPSocket.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

The UDPSocket class provides the ability to send packets of data over UDP, using the `sendto` and `recvfrom` member functions. Packets can be lost or arrive out of order, so we suggest using a [TCPSocket](/docs/v5.6/reference/tcpsocket.html) when you require guaranteed delivery.

The constructor takes in the NetworkStack pointer to open the socket on the specified NetworkInterface. If NetworkStack is not passed in the constructor, then you must call `open` to initialize the socket.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Query: Who or what passes in the constructor?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NetworkStack pointer


### UDPSocket class reference

[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.6/mbed-os-api-doxy/class_u_d_p_socket.html)

### UDPSocket Example

Here is a UDP example to read the current UTC time by sending a request to the NIST Internet Time Service.

[![View code](https://www.mbed.com/embed/?url=https://os.mbed.com/teams/mbed_example/code/mbed-os-example-udp-sockets)](https://os.mbed.com/teams/mbed_example/code/mbed-os-example-udp-sockets/file/cf516d904427/main.cpp)