Skip to content

Commit

Permalink
doc: add added: information for dgram
Browse files Browse the repository at this point in the history
PR-URL: #8196
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
lpinca authored and Fishrock123 committed Sep 9, 2016
1 parent 260663f commit 93ac875
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions doc/api/dgram.md
Expand Up @@ -29,6 +29,9 @@ server.bind(41234);
``` ```


## Class: dgram.Socket ## Class: dgram.Socket
<!-- YAML
added: v0.1.99
-->


The `dgram.Socket` object is an [`EventEmitter`][] that encapsulates the The `dgram.Socket` object is an [`EventEmitter`][] that encapsulates the
datagram functionality. datagram functionality.
Expand All @@ -37,23 +40,35 @@ New instances of `dgram.Socket` are created using [`dgram.createSocket()`][].
The `new` keyword is not to be used to create `dgram.Socket` instances. The `new` keyword is not to be used to create `dgram.Socket` instances.


### Event: 'close' ### Event: 'close'
<!-- YAML
added: v0.1.99
-->


The `'close'` event is emitted after a socket is closed with [`close()`][]. The `'close'` event is emitted after a socket is closed with [`close()`][].
Once triggered, no new `'message'` events will be emitted on this socket. Once triggered, no new `'message'` events will be emitted on this socket.


### Event: 'error' ### Event: 'error'
<!-- YAML
added: v0.1.99
-->


* `exception` {Error} * `exception` {Error}


The `'error'` event is emitted whenever any error occurs. The event handler The `'error'` event is emitted whenever any error occurs. The event handler
function is passed a single Error object. function is passed a single Error object.


### Event: 'listening' ### Event: 'listening'
<!-- YAML
added: v0.1.99
-->


The `'listening'` event is emitted whenever a socket begins listening for The `'listening'` event is emitted whenever a socket begins listening for
datagram messages. This occurs as soon as UDP sockets are created. datagram messages. This occurs as soon as UDP sockets are created.


### Event: 'message' ### Event: 'message'
<!-- YAML
added: v0.1.99
-->


* `msg` {Buffer} - The message * `msg` {Buffer} - The message
* `rinfo` {Object} - Remote address information * `rinfo` {Object} - Remote address information
Expand Down Expand Up @@ -85,12 +100,18 @@ one interface and will add membership to it. To add membership to every
available interface, call `addMembership` multiple times, once per interface. available interface, call `addMembership` multiple times, once per interface.


### socket.address() ### socket.address()
<!-- YAML
added: v0.1.99
-->


Returns an object containing the address information for a socket. Returns an object containing the address information for a socket.
For UDP sockets, this object will contain `address`, `family` and `port` For UDP sockets, this object will contain `address`, `family` and `port`
properties. properties.


### socket.bind([port][, address][, callback]) ### socket.bind([port][, address][, callback])
<!-- YAML
added: v0.1.99
-->


* `port` {Number} - Integer, Optional * `port` {Number} - Integer, Optional
* `address` {String}, Optional * `address` {String}, Optional
Expand Down Expand Up @@ -139,6 +160,9 @@ server.bind(41234);
``` ```


### socket.bind(options[, callback]) ### socket.bind(options[, callback])
<!-- YAML
added: v0.11.14
-->


* `options` {Object} - Required. Supports the following properties: * `options` {Object} - Required. Supports the following properties:
* `port` {Number} - Required. * `port` {Number} - Required.
Expand Down Expand Up @@ -172,6 +196,9 @@ socket.bind({
``` ```


### socket.close([callback]) ### socket.close([callback])
<!-- YAML
added: v0.1.99
-->


Close the underlying socket and stop listening for data on it. If a callback is Close the underlying socket and stop listening for data on it. If a callback is
provided, it is added as a listener for the [`'close'`][] event. provided, it is added as a listener for the [`'close'`][] event.
Expand All @@ -193,6 +220,9 @@ 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(msg, [offset, length,] port, address[, callback]) ### socket.send(msg, [offset, length,] port, address[, callback])
<!-- YAML
added: v0.1.99
-->


* `msg` {Buffer|String|Array} Message to be sent * `msg` {Buffer|String|Array} Message to be sent
* `offset` {Number} Integer. Optional. Offset in the buffer where the message starts. * `offset` {Number} Integer. Optional. Offset in the buffer where the message starts.
Expand Down Expand Up @@ -300,13 +330,19 @@ Sets or clears the `SO_BROADCAST` socket option. When set to `true`, UDP
packets may be sent to a local interface's broadcast address. packets may be sent to a local interface's broadcast address.


### socket.setMulticastLoopback(flag) ### socket.setMulticastLoopback(flag)
<!-- YAML
added: v0.3.8
-->


* `flag` {Boolean} * `flag` {Boolean}


Sets or clears the `IP_MULTICAST_LOOP` socket option. When set to `true`, Sets or clears the `IP_MULTICAST_LOOP` socket option. When set to `true`,
multicast packets will also be received on the local interface. multicast packets will also be received on the local interface.


### socket.setMulticastTTL(ttl) ### socket.setMulticastTTL(ttl)
<!-- YAML
added: v0.3.8
-->


* `ttl` {Number} Integer * `ttl` {Number} Integer


Expand All @@ -320,6 +356,9 @@ The argument passed to to `socket.setMulticastTTL()` is a number of hops
between 0 and 255. The default on most systems is `1` but can vary. between 0 and 255. The default on most systems is `1` but can vary.


### socket.setTTL(ttl) ### socket.setTTL(ttl)
<!-- YAML
added: v0.1.101
-->


* `ttl` {Number} Integer * `ttl` {Number} Integer


Expand All @@ -333,6 +372,9 @@ The argument to `socket.setTTL()` is a number of hops between 1 and 255.
The default on most systems is 64 but can vary. The default on most systems is 64 but can vary.


### socket.ref() ### socket.ref()
<!-- YAML
added: v0.9.1
-->


By default, binding a socket will cause it to block the Node.js process from By default, binding a socket will cause it to block the Node.js process from
exiting as long as the socket is open. The `socket.unref()` method can be used exiting as long as the socket is open. The `socket.unref()` method can be used
Expand All @@ -346,6 +388,9 @@ The `socket.ref()` method returns a reference to the socket so calls can be
chained. chained.


### socket.unref() ### socket.unref()
<!-- YAML
added: v0.9.1
-->


By default, binding a socket will cause it to block the Node.js process from By default, binding a socket will cause it to block the Node.js process from
exiting as long as the socket is open. The `socket.unref()` method can be used exiting as long as the socket is open. The `socket.unref()` method can be used
Expand Down Expand Up @@ -383,6 +428,9 @@ s.bind(1234, () => {
## `dgram` module functions ## `dgram` module functions


### dgram.createSocket(options[, callback]) ### dgram.createSocket(options[, callback])
<!-- YAML
added: v0.11.13
-->


* `options` {Object} * `options` {Object}
* `callback` {Function} Attached as a listener to `'message'` events. * `callback` {Function} Attached as a listener to `'message'` events.
Expand All @@ -405,6 +453,9 @@ and `udp6` sockets). The bound address and port can be retrieved using
[`socket.address().address`][] and [`socket.address().port`][]. [`socket.address().address`][] and [`socket.address().port`][].


### dgram.createSocket(type[, callback]) ### dgram.createSocket(type[, callback])
<!-- YAML
added: v0.1.99
-->


* `type` {String} - Either 'udp4' or 'udp6' * `type` {String} - Either 'udp4' or 'udp6'
* `callback` {Function} - Attached as a listener to `'message'` events. * `callback` {Function} - Attached as a listener to `'message'` events.
Expand Down

0 comments on commit 93ac875

Please sign in to comment.