FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc,dgram: use code markup/markdown in headers · nodejs/node@c2ad43a · GitHub

/ node Public

Commit c2ad43a

Browse files
Trott
authored and
BethGriggs
committed
doc,dgram: use code markup/markdown in headers
Backport-PR-URL: #31108 PR-URL: #31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
1 parent 448a117 commit c2ad43a

1 file changed

Lines changed: 29 additions & 29 deletions

File tree

‎doc/api/dgram.md‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -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
3535
added: v0.1.99
3636
-->
@@ -42,23 +42,23 @@ Encapsulates the datagram functionality.
4242
New instances of `dgram.Socket` are created using [`dgram.createSocket()`][].
4343
The `new` keyword is not to be used to create `dgram.Socket` instances.
4444

45-
### Event: 'close'
45+
### Event: `'close'`
4646
<!-- YAML
4747
added: v0.1.99
4848
-->
4949

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

53-
### Event: 'connect'
53+
### Event: `'connect'`
5454
<!-- YAML
5555
added: v12.0.0
5656
-->
5757

5858
The `'connect'` event is emitted after a socket is associated to a remote
5959
address as a result of a successful [`connect()`][] call.
6060

61-
### Event: 'error'
61+
### Event: `'error'`
6262
<!-- YAML
6363
added: v0.1.99
6464
-->
@@ -68,15 +68,15 @@ added: v0.1.99
6868
The `'error'` event is emitted whenever any error occurs. The event handler
6969
function is passed a single `Error` object.
7070

71-
### Event: 'listening'
71+
### Event: `'listening'`
7272
<!-- YAML
7373
added: v0.1.99
7474
-->
7575

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

79-
### Event: 'message'
79+
### Event: `'message'`
8080
<!-- YAML
8181
added: 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
9696
added: v0.6.9
9797
-->
@@ -123,7 +123,7 @@ if (cluster.isMaster) {
123123
}
124124
```
125125

126-
### socket.address()
126+
### `socket.address()`
127127
<!-- YAML
128128
added: v0.1.99
129129
-->
@@ -134,7 +134,7 @@ Returns an object containing the address information for a socket.
134134
For UDP sockets, this object will contain `address`, `family` and `port`
135135
properties.
136136

137-
### socket.bind(\[port\]\[, address\]\[, callback\])
137+
### `socket.bind([port][, address][, callback])`
138138
<!-- YAML
139139
added: v0.1.99
140140
changes:
@@ -190,7 +190,7 @@ server.bind(41234);
190190
// Prints: server listening 0.0.0.0:41234
191191
```
192192

193-
### socket.bind(options\[, callback\])
193+
### `socket.bind(options[, callback])`
194194
<!-- YAML
195195
added: v0.11.14
196196
-->
@@ -243,7 +243,7 @@ socket.bind({
243243
});
244244
```
245245

246-
### socket.close(\[callback\])
246+
### `socket.close([callback])`
247247
<!-- YAML
248248
added: v0.1.99
249249
-->
@@ -253,7 +253,7 @@ added: v0.1.99
253253
Close the underlying socket and stop listening for data on it. If a callback is
254254
provided, it is added as a listener for the [`'close'`][] event.
255255

256-
### socket.connect(port\[, address\]\[, callback\])
256+
### `socket.connect(port[, address][, callback])`
257257
<!-- YAML
258258
added: v12.0.0
259259
-->
@@ -272,7 +272,7 @@ will be used by default. Once the connection is complete, a `'connect'` event
272272
is emitted and the optional `callback` function is called. In case of failure,
273273
the `callback` is called or, failing this, an `'error'` event is emitted.
274274

275-
### socket.disconnect()
275+
### `socket.disconnect()`
276276
<!-- YAML
277277
added: v12.0.0
278278
-->
@@ -281,7 +281,7 @@ A synchronous function that disassociates a connected `dgram.Socket` from
281281
its remote address. Trying to call `disconnect()` on an already disconnected
282282
socket will result in an [`ERR_SOCKET_DGRAM_NOT_CONNECTED`][] exception.
283283

284-
### socket.dropMembership(multicastAddress\[, multicastInterface\])
284+
### `socket.dropMembership(multicastAddress[, multicastInterface])`
285285
<!-- YAML
286286
added: v0.6.9
287287
-->
@@ -297,21 +297,21 @@ never have reason to call this.
297297
If `multicastInterface` is not specified, the operating system will attempt to
298298
drop membership on all valid interfaces.
299299

300-
### socket.getRecvBufferSize()
300+
### `socket.getRecvBufferSize()`
301301
<!-- YAML
302302
added: v8.7.0
303303
-->
304304

305305
* Returns: {number} the `SO_RCVBUF` socket receive buffer size in bytes.
306306

307-
### socket.getSendBufferSize()
307+
### `socket.getSendBufferSize()`
308308
<!-- YAML
309309
added: v8.7.0
310310
-->
311311

312312
* Returns: {number} the `SO_SNDBUF` socket send buffer size in bytes.
313313

314-
### socket.ref()
314+
### `socket.ref()`
315315
<!-- YAML
316316
added: v0.9.1
317317
-->
@@ -329,7 +329,7 @@ Calling `socket.ref()` multiples times will have no additional effect.
329329
The `socket.ref()` method returns a reference to the socket so calls can be
330330
chained.
331331

332-
### socket.remoteAddress()
332+
### `socket.remoteAddress()`
333333
<!-- YAML
334334
added: v12.0.0
335335
-->
@@ -340,7 +340,7 @@ Returns an object containing the `address`, `family`, and `port` of the remote
340340
endpoint. It throws an [`ERR_SOCKET_DGRAM_NOT_CONNECTED`][] exception if the
341341
socket is not connected.
342342

343-
### socket.send(msg\[, offset, length\]\[, port\]\[, address\]\[, callback\])
343+
### `socket.send(msg[, offset, length][, port][, address][, callback])`
344344
<!-- YAML
345345
added: v0.1.99
346346
changes:
@@ -478,7 +478,7 @@ a packet might travel. Sending a datagram greater than the receiver `MTU` will
478478
not work because the packet will get silently dropped without informing the
479479
source that the data did not reach its intended recipient.
480480

481-
### socket.setBroadcast(flag)
481+
### `socket.setBroadcast(flag)`
482482
<!-- YAML
483483
added: v0.6.9
484484
-->
@@ -488,7 +488,7 @@ added: v0.6.9
488488
Sets or clears the `SO_BROADCAST` socket option. When set to `true`, UDP
489489
packets may be sent to a local interface's broadcast address.
490490

491-
### socket.setMulticastInterface(multicastInterface)
491+
### `socket.setMulticastInterface(multicastInterface)`
492492
<!-- YAML
493493
added: v8.6.0
494494
-->
@@ -566,7 +566,7 @@ A socket's address family's ANY address (IPv4 `'0.0.0.0'` or IPv6 `'::'`) can be
566566
used to return control of the sockets default outgoing interface to the system
567567
for future multicast packets.
568568

569-
### socket.setMulticastLoopback(flag)
569+
### `socket.setMulticastLoopback(flag)`
570570
<!-- YAML
571571
added: v0.3.8
572572
-->
@@ -576,7 +576,7 @@ added: v0.3.8
576576
Sets or clears the `IP_MULTICAST_LOOP` socket option. When set to `true`,
577577
multicast packets will also be received on the local interface.
578578

579-
### socket.setMulticastTTL(ttl)
579+
### `socket.setMulticastTTL(ttl)`
580580
<!-- YAML
581581
added: v0.3.8
582582
-->
@@ -591,7 +591,7 @@ decremented to 0 by a router, it will not be forwarded.
591591

592592
The `ttl` argument may be between 0 and 255. The default on most systems is `1`.
593593

594-
### socket.setRecvBufferSize(size)
594+
### `socket.setRecvBufferSize(size)`
595595
<!-- YAML
596596
added: v8.7.0
597597
-->
@@ -601,7 +601,7 @@ added: v8.7.0
601601
Sets the `SO_RCVBUF` socket option. Sets the maximum socket receive buffer
602602
in bytes.
603603

604-
### socket.setSendBufferSize(size)
604+
### `socket.setSendBufferSize(size)`
605605
<!-- YAML
606606
added: v8.7.0
607607
-->
@@ -611,7 +611,7 @@ added: v8.7.0
611611
Sets the `SO_SNDBUF` socket option. Sets the maximum socket send buffer
612612
in bytes.
613613

614-
### socket.setTTL(ttl)
614+
### `socket.setTTL(ttl)`
615615
<!-- YAML
616616
added: v0.1.101
617617
-->
@@ -627,7 +627,7 @@ Changing TTL values is typically done for network probes or when multicasting.
627627
The `ttl` argument may be between between 1 and 255. The default on most systems
628628
is 64.
629629

630-
### socket.unref()
630+
### `socket.unref()`
631631
<!-- YAML
632632
added: v0.9.1
633633
-->
@@ -647,7 +647,7 @@ chained.
647647

648648
## `dgram` module functions
649649

650-
### dgram.createSocket(options\[, callback\])
650+
### `dgram.createSocket(options[, callback])`
651651
<!-- YAML
652652
added: v0.11.13
653653
changes:
@@ -686,7 +686,7 @@ method will bind the socket to the "all interfaces" address on a random port
686686
and port can be retrieved using [`socket.address().address`][] and
687687
[`socket.address().port`][].
688688

689-
### dgram.createSocket(type\[, callback\])
689+
### `dgram.createSocket(type[, callback])`
690690
<!-- YAML
691691
added: v0.1.99
692692
-->

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL