Skip to content
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

Jump to bottom

doc: clarify dgram socket.send() multi-buffer support #5130

Closed
wants to merge 1 commit into from
Closed

doc: clarify dgram socket.send() multi-buffer support #5130

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 11 additions & 7 deletions doc/api/dgram.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,24 +185,28 @@ never have reason to call this.
If `multicastInterface` is not specified, the operating system will attempt to
drop membership on all valid interfaces.

### socket.send(buf, [offset, length,] port, address[, callback])
### socket.send(msg, [offset, length,] port, address[, callback])

* `buf` Buffer object, string, or an array of either. Message to be
* `msg` Buffer object, string, or an array of either. Message to be
sent.
* `offset` Integer. Offset in the buffer where the message starts.
* `length` Integer. Number of bytes in the message.
* `offset` Integer. Optional. Offset in the buffer where the message starts.
* `length` Integer. Optional. Number of bytes in the message.
* `port` Integer. Destination port.
* `address` String. Destination hostname or IP address.
* `callback` Function. Called when the message has been sent. Optional.

Broadcasts a datagram on the socket. The destination `port` and `address` must
be specified.

The `buf` argument is a [`Buffer`] object containing the message. The `offset`
and `length` specify the offset within the `Buffer` where the message begins
and the number of bytes in the message, respectively. With messages that
The `msg` argument containins the message to be sent.
Depending on its type, different behavior can apply. If `msg` is a `Buffer`,
the `offset` and `length` specify the offset within the `Buffer` where the
message begins and the number of bytes in the message, respectively.
If `msg` is a `String`, then it is automatically converted to a `Buffer`
with `'utf8'` enecoding. With messages that
contain multi-byte characters, `offset` and `length` will be calculated with
respect to [byte length][] and not the character position.
If `msg` is an array, `offset` and `length` must not be specified.

The `address` argument is a string. If the value of `address` is a host name,
DNS will be used to resolve the address of the host. If the `address` is not
Expand Down