UDP sockect doc update #296
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Make minor copy edits, such as adding articles.
AnotherButler
approved these changes
Oct 18, 2017
sg-
suggested changes
Oct 23, 2017
|
@sg- Please review |
sg-
reviewed
Oct 26, 2017
| @@ -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](/docs/v5.6/mbed-os-api-doxy/class_network_stack.html) or [NetworkInterface](/docs/v5.6/mbed-os-api-doxy/class_network_interface.html) pointer to open the socket on specified NetworkInterface. If NetworkInterface is not passed in constructor, than you must call `open` to initialize the socket. | |||
Make minor copy edit to add articles.
| @@ -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. | |||
There was a problem hiding this comment.
Query: Who or what passes in the constructor?
added 2 commits
October 30, 2017 10:33
Make minor update to change passive voice to active voice.
Fix content I accidentally changed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Jira: https://jira.arm.com/browse/IOTMORF-1309
Added the example reference of UDP client
@sg- Please review