lukechilds
/
node
mirror of https://github.com/lukechilds/node.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

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

Fixes: #5124
See: https://github.com/nodejs/node/pull/4374
PR-URL: https://github.com/nodejs/node/pull/5130
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
v5.x
Matteo Collina 9 years ago
committed by Rod Vagg
parent
a96ae2cb37
commit
9f7aa6f868
1 changed files with 12 additions and 7 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 19
      doc/api/dgram.markdown

19
doc/api/dgram.markdown
View File

@ -185,11 +185,12 @@ never have reason to call this.
If `multicastInterface` is not specified, the operating system will attempt to If `multicastInterface` is not specified, the operating system will attempt to
drop membership on all valid interfaces. 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 or string. Message to be sent * `msg` Buffer object, string, or an array of either. Message to be
* `offset` Integer. Offset in the buffer where the message starts. sent.
* `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. * `port` Integer. Destination port.
* `address` String. Destination hostname or IP address. * `address` String. Destination hostname or IP address.
* `callback` Function. Called when the message has been sent. Optional. * `callback` Function. Called when the message has been sent. Optional.
@ -197,11 +198,15 @@ drop membership on all valid interfaces.
Broadcasts a datagram on the socket. The destination `port` and `address` must Broadcasts a datagram on the socket. The destination `port` and `address` must
be specified. be specified.
The `buf` argument is a [`Buffer`] object containing the message. The `offset` The `msg` argument containins the message to be sent.
and `length` specify the offset within the `Buffer` where the message begins Depending on its type, different behavior can apply. If `msg` is a `Buffer`,
and the number of bytes in the message, respectively. With messages that 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 contain multi-byte characters, `offset` and `length` will be calculated with
respect to [byte length][] and not the character position. 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, 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 DNS will be used to resolve the address of the host. If the `address` is not

Write Preview
Loading…
Cancel
Save