UDP/Datagram Sockets documentation #23952

Activity

1. bnoordhuis

   added

   dgramIssues and PRs related to UDP and the dgram module.Issues and PRs related to UDP and the dgram module.

   docIssues and PRs related to Node.js documentation.Issues and PRs related to Node.js documentation.

   on Oct 29, 2018
2. bnoordhuis commented on Oct 29, 2018

   

   bnoordhuis

   on Oct 29, 2018

   Last edited by bnoordhuis

   Member

   More actions

   I agree the wording is kind of confusing, even if it's technically correct.

   "As UDP sockets are created" refers to the underlying OS socket. They're addressable the moment they're created but Node.js delays creating them until the first send() or bind(). To illustrate:

   const dgram = require('dgram')
   const s = dgram.createSocket('udp4')
   //console.log(s.address())  // would fail with "getsockname EINVAL", no socket yet
   s.on('listening', () => console.log(s.address())
   s.send('', 12345, () => console.log('done'))
   // Prints:
   //   { address: '0.0.0.0', family: 'IPv4', port: <random port> }
   //   done 

   👍React with 👍1Reacted by Benjamin Gruenbaum
3. dsinecos commented on Oct 29, 2018

   

   dsinecos

   on Oct 29, 2018

   ContributorAuthor

   More actions

   Thanks @bnoordhuis :)
   This cleared up my confusion.

   Borrowing from your explanation I think the existing description could be modified to something like the following -

   " The listening event is emitted on the first invocation of either send() or bind() for the respective socket.

   While the sockets are addressable immediately after creation using dgram.createSocket NodeJS delays creating the underlying OS socket until the first send() or bind() call is made for the respective socket.

   The listening event is emitted when the underlying OS socket is created (ie on the first invocation of either send() or bind()) "
4. bnoordhuis commented on Oct 29, 2018

   

   bnoordhuis

   on Oct 29, 2018

   Member

   More actions

   Yes, sounds good. Maybe even cut it short by a few more words. Want to open a PR?
5. dsinecos commented on Oct 29, 2018

   

   dsinecos

   on Oct 29, 2018

   Last edited by dsinecos

   ContributorAuthor

   More actions

   Yup, I'll edit it and open a PR

   Edit: Submitted a PR here - #23959
6. dsinecos

   added a commit that references this issue on Nov 29, 2018

   doc: clarify when `'listening'` event is emitted

   ...

   70b0e8e
7. tjconcept commented on Apr 14, 2020

   

   tjconcept

   on Apr 14, 2020

   Contributor

   More actions

   I believe this issue should be closed as #32581 landed.
8. jasnell

   added

   help wantedIssues that need assistance from volunteers or PRs that need help to proceed.Issues that need assistance from volunteers or PRs that need help to proceed.

   on Jun 26, 2020
9. jasnell

   closed this as completedon Jun 26, 2020