@@ -30,7 +30,7 @@ server.bind(41234);
3030// Prints: server listening 0.0.0.0:41234
3131```
3232
33- ## Class: dgram.Socket
33+ ## Class: ` dgram.Socket `
3434<!-- YAML
3535added: v0.1.99
3636-->
@@ -42,23 +42,23 @@ Encapsulates the datagram functionality.
4242New instances of ` dgram.Socket ` are created using [ ` dgram.createSocket() ` ] [ ] .
4343The ` new ` keyword is not to be used to create ` dgram.Socket ` instances.
4444
45- ### Event: 'close'
45+ ### Event: ` 'close' `
4646<!-- YAML
4747added: v0.1.99
4848-->
4949
5050The ` 'close' ` event is emitted after a socket is closed with [ ` close() ` ] [ ] .
5151Once triggered, no new ` 'message' ` events will be emitted on this socket.
5252
53- ### Event: 'connect'
53+ ### Event: ` 'connect' `
5454<!-- YAML
5555added: v12.0.0
5656-->
5757
5858The ` 'connect' ` event is emitted after a socket is associated to a remote
5959address as a result of a successful [ ` connect() ` ] [ ] call.
6060
61- ### Event: 'error'
61+ ### Event: ` 'error' `
6262<!-- YAML
6363added: v0.1.99
6464-->
@@ -68,15 +68,15 @@ added: v0.1.99
6868The ` 'error' ` event is emitted whenever any error occurs. The event handler
6969function is passed a single ` Error ` object.
7070
71- ### Event: 'listening'
71+ ### Event: ` 'listening' `
7272<!-- YAML
7373added: v0.1.99
7474-->
7575
7676The ` 'listening' ` event is emitted whenever a socket begins listening for
7777datagram messages. This occurs as soon as UDP sockets are created.
7878
79- ### Event: 'message'
79+ ### Event: ` 'message' `
8080<!-- YAML
8181added: v0.1.99
8282-->
@@ -91,7 +91,7 @@ The event handler function is passed two arguments: `msg` and `rinfo`.
9191 * ` port ` {number} The sender port.
9292 * ` size ` {number} The message size.
9393
94- ### socket.addMembership(multicastAddress\ [ , multicastInterface\] )
94+ ### ` socket.addMembership(multicastAddress[, multicastInterface]) `
9595<!-- YAML
9696added: v0.6.9
9797-->
@@ -123,7 +123,7 @@ if (cluster.isMaster) {
123123}
124124```
125125
126- ### socket.addSourceSpecificMembership(sourceAddress, groupAddress\ [ , multicastInterface\] )
126+ ### ` socket.addSourceSpecificMembership(sourceAddress, groupAddress[, multicastInterface]) `
127127<!-- YAML
128128added: v13.1.0
129129-->
@@ -138,7 +138,7 @@ is not specified, the operating system will choose one interface and will add
138138membership to it. To add membership to every available interface, call
139139` socket.addSourceSpecificMembership() ` multiple times, once per interface.
140140
141- ### socket.address()
141+ ### ` socket.address() `
142142<!-- YAML
143143added: v0.1.99
144144-->
@@ -149,7 +149,7 @@ Returns an object containing the address information for a socket.
149149For UDP sockets, this object will contain ` address ` , ` family ` and ` port `
150150properties.
151151
152- ### socket.bind(\ [ port\]\ [ , address\]\ [ , callback\] )
152+ ### ` socket.bind([port] [, address] [, callback]) `
153153<!-- YAML
154154added: v0.1.99
155155changes:
@@ -205,7 +205,7 @@ server.bind(41234);
205205// Prints: server listening 0.0.0.0:41234
206206```
207207
208- ### socket.bind(options\ [ , callback\] )
208+ ### ` socket.bind(options[, callback]) `
209209<!-- YAML
210210added: v0.11.14
211211-->
@@ -258,7 +258,7 @@ socket.bind({
258258});
259259```
260260
261- ### socket.close(\ [ callback\] )
261+ ### ` socket.close([callback]) `
262262<!-- YAML
263263added: v0.1.99
264264-->
@@ -268,7 +268,7 @@ added: v0.1.99
268268Close the underlying socket and stop listening for data on it. If a callback is
269269provided, it is added as a listener for the [ ` 'close' ` ] [ ] event.
270270
271- ### socket.connect(port\ [ , address\]\ [ , callback\] )
271+ ### ` socket.connect(port[, address] [, callback]) `
272272<!-- YAML
273273added: v12.0.0
274274-->
@@ -287,7 +287,7 @@ will be used by default. Once the connection is complete, a `'connect'` event
287287is emitted and the optional ` callback ` function is called. In case of failure,
288288the ` callback ` is called or, failing this, an ` 'error' ` event is emitted.
289289
290- ### socket.disconnect()
290+ ### ` socket.disconnect() `
291291<!-- YAML
292292added: v12.0.0
293293-->
@@ -296,7 +296,7 @@ A synchronous function that disassociates a connected `dgram.Socket` from
296296its remote address. Trying to call ` disconnect() ` on an already disconnected
297297socket will result in an [ ` ERR_SOCKET_DGRAM_NOT_CONNECTED ` ] [ ] exception.
298298
299- ### socket.dropMembership(multicastAddress\ [ , multicastInterface\] )
299+ ### ` socket.dropMembership(multicastAddress[, multicastInterface]) `
300300<!-- YAML
301301added: v0.6.9
302302-->
@@ -312,7 +312,7 @@ never have reason to call this.
312312If ` multicastInterface ` is not specified, the operating system will attempt to
313313drop membership on all valid interfaces.
314314
315- ### socket.dropSourceSpecificMembership(sourceAddress, groupAddress\ [ , multicastInterface\] )
315+ ### ` socket.dropSourceSpecificMembership(sourceAddress, groupAddress[, multicastInterface]) `
316316<!-- YAML
317317added: v13.1.0
318318-->
@@ -330,21 +330,21 @@ reason to call this.
330330If ` multicastInterface ` is not specified, the operating system will attempt to
331331drop membership on all valid interfaces.
332332
333- ### socket.getRecvBufferSize()
333+ ### ` socket.getRecvBufferSize() `
334334<!-- YAML
335335added: v8.7.0
336336-->
337337
338338* Returns: {number} the ` SO_RCVBUF ` socket receive buffer size in bytes.
339339
340- ### socket.getSendBufferSize()
340+ ### ` socket.getSendBufferSize() `
341341<!-- YAML
342342added: v8.7.0
343343-->
344344
345345* Returns: {number} the ` SO_SNDBUF ` socket send buffer size in bytes.
346346
347- ### socket.ref()
347+ ### ` socket.ref() `
348348<!-- YAML
349349added: v0.9.1
350350-->
@@ -362,7 +362,7 @@ Calling `socket.ref()` multiples times will have no additional effect.
362362The ` socket.ref() ` method returns a reference to the socket so calls can be
363363chained.
364364
365- ### socket.remoteAddress()
365+ ### ` socket.remoteAddress() `
366366<!-- YAML
367367added: v12.0.0
368368-->
@@ -373,7 +373,7 @@ Returns an object containing the `address`, `family`, and `port` of the remote
373373endpoint. It throws an [ ` ERR_SOCKET_DGRAM_NOT_CONNECTED ` ] [ ] exception if the
374374socket is not connected.
375375
376- ### socket.send(msg\ [ , offset, length\]\ [ , port\]\ [ , address\]\ [ , callback\] )
376+ ### ` socket.send(msg[, offset, length] [, port] [, address] [, callback]) `
377377<!-- YAML
378378added: v0.1.99
379379changes:
@@ -511,7 +511,7 @@ a packet might travel. Sending a datagram greater than the receiver `MTU` will
511511not work because the packet will get silently dropped without informing the
512512source that the data did not reach its intended recipient.
513513
514- ### socket.setBroadcast(flag)
514+ ### ` socket.setBroadcast(flag) `
515515<!-- YAML
516516added: v0.6.9
517517-->
@@ -521,7 +521,7 @@ added: v0.6.9
521521Sets or clears the ` SO_BROADCAST ` socket option. When set to ` true ` , UDP
522522packets may be sent to a local interface's broadcast address.
523523
524- ### socket.setMulticastInterface(multicastInterface)
524+ ### ` socket.setMulticastInterface(multicastInterface) `
525525<!-- YAML
526526added: v8.6.0
527527-->
@@ -599,7 +599,7 @@ A socket's address family's ANY address (IPv4 `'0.0.0.0'` or IPv6 `'::'`) can be
599599used to return control of the sockets default outgoing interface to the system
600600for future multicast packets.
601601
602- ### socket.setMulticastLoopback(flag)
602+ ### ` socket.setMulticastLoopback(flag) `
603603<!-- YAML
604604added: v0.3.8
605605-->
@@ -609,7 +609,7 @@ added: v0.3.8
609609Sets or clears the ` IP_MULTICAST_LOOP ` socket option. When set to ` true ` ,
610610multicast packets will also be received on the local interface.
611611
612- ### socket.setMulticastTTL(ttl)
612+ ### ` socket.setMulticastTTL(ttl) `
613613<!-- YAML
614614added: v0.3.8
615615-->
@@ -624,7 +624,7 @@ decremented to 0 by a router, it will not be forwarded.
624624
625625The ` ttl ` argument may be between 0 and 255. The default on most systems is ` 1 ` .
626626
627- ### socket.setRecvBufferSize(size)
627+ ### ` socket.setRecvBufferSize(size) `
628628<!-- YAML
629629added: v8.7.0
630630-->
@@ -634,7 +634,7 @@ added: v8.7.0
634634Sets the ` SO_RCVBUF ` socket option. Sets the maximum socket receive buffer
635635in bytes.
636636
637- ### socket.setSendBufferSize(size)
637+ ### ` socket.setSendBufferSize(size) `
638638<!-- YAML
639639added: v8.7.0
640640-->
@@ -644,7 +644,7 @@ added: v8.7.0
644644Sets the ` SO_SNDBUF ` socket option. Sets the maximum socket send buffer
645645in bytes.
646646
647- ### socket.setTTL(ttl)
647+ ### ` socket.setTTL(ttl) `
648648<!-- YAML
649649added: v0.1.101
650650-->
@@ -660,7 +660,7 @@ Changing TTL values is typically done for network probes or when multicasting.
660660The ` ttl ` argument may be between between 1 and 255. The default on most systems
661661is 64.
662662
663- ### socket.unref()
663+ ### ` socket.unref() `
664664<!-- YAML
665665added: v0.9.1
666666-->
@@ -680,7 +680,7 @@ chained.
680680
681681## ` dgram ` module functions
682682
683- ### dgram.createSocket(options\ [ , callback\] )
683+ ### ` dgram.createSocket(options[, callback]) `
684684<!-- YAML
685685added: v0.11.13
686686changes:
@@ -719,7 +719,7 @@ method will bind the socket to the "all interfaces" address on a random port
719719and port can be retrieved using [ ` socket.address().address ` ] [ ] and
720720[ ` socket.address().port ` ] [ ] .
721721
722- ### dgram.createSocket(type\ [ , callback\] )
722+ ### ` dgram.createSocket(type[, callback]) `
723723<!-- YAML
724724added: v0.1.99
725725-->
0 commit comments