chore: add LICENSE and update docs

Author: oyyd

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2022 <COPYRIGHT HOLDER>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -147,6 +147,4 @@ setInterval(() => {
 ```
 
 ## LICENSE
-
-## TODO
-- seqpacket sockets should be closed automatically
+MIT

docs/README.md

@@ -16,9 +16,14 @@ nix-socket / [Exports](modules.md)
 ## `SO_REUSEPORT` enabled TCP net.Server
 
 The [cluster](https://nodejs.org/dist/latest-v18.x/docs/api/cluster.html) module share server ports by accepting new connections in the primary process and distributing them to worker processes.
+
 With `SO_REUSEPORT`, sockets will be distributed by kernel instead, and which should be more performant especially for scenario of having a lot of short-lived connections.
 
-Note that `SO_REUSEPORT` might behave much differently across operating systems. See this informative [post](https://stackoverflow.com/questions/14388706/how-do-so-reuseaddr-and-so-reuseport-differ) for more information.
+For example, the arrow in the image below shows cpu usage of a PM2 primary process which we found in our environment.
+
+![cpu_usage](./resource/cpu_usage.png)
+
+Note that `SO_REUSEPORT` might behave much differently across operating systems. See this [post](https://stackoverflow.com/questions/14388706/how-do-so-reuseaddr-and-so-reuseport-differ) for more information.
 
 ### Example
 
@@ -48,39 +53,102 @@ for (let i = 0; i < 2; i += 1) {
 }
 
 setInterval(() => {
-    const client = new Socket()
-    client.on('data', (buf) => {
-      console.log('client received:', buf)
-      client.destroy()
-    })
-    client.connect(port, host, () => {
-      client.write(Buffer.from('hello'))
-    })
+  const client = new Socket()
+  client.on('data', (buf) => {
+    console.log('client received:', buf)
+    client.destroy()
+  })
+  client.connect(port, host, () => {
+    client.write(Buffer.from('hello'))
+  })
 }, 1000)
 ```
 
 ## Seqpacket Sockets
 
+`SOCK_SEQPACKET` sockets are like `SOCK_DGRAM` sockets and they will keep message boundaries.
+
+Note that `SOCK_SEQPACKET` sockets don't work on MacOS.
+
+### Example
+
 ```js
 const { SeqpacketServer, SeqpacketSocket } = require('nix-socket')
 const os = require('os')
 const path = require('path')
+const fs = require('fs')
 
-const bindPath = path.resolve(os.tmp(), './my.sock')
+const bindPath = path.resolve(os.tmpdir(), './my_seqpacket.sock')
 
-const server = new SeqpacketServer()
+try { fs.unlinkSync(bindPath) } catch (e) {}
 
+const server = new SeqpacketServer()
 server.listen(bindPath)
+server.on('connection', socket => {
+  socket.on('data', buf => {
+    console.log('received', buf.toString())
+  })
+});
 
 const client = new SeqpacketSocket()
-
-// TODO
-client.write()
+client.connect(bindPath, () => {
+  const data = [
+    'hello, ',
+    'w',
+    'o',
+    'r',
+    'l',
+    'd'
+  ]
+
+  for (const str of data) {
+    client.write(Buffer.from(str))
+  }
+  client.end()
+})
 ```
 
 ## Dgram Sockets
 
+### Example
+
 ```js
+const { DgramSocket } = require('nix-socket')
+const os = require('os')
+const path = require('path')
+const fs = require('fs')
+
+const path1 = path.resolve(os.tmpdir(), './my_dgram_1.sock')
+const path2 = path.resolve(os.tmpdir(), './my_dgram_2.sock')
+
+try {
+  fs.unlinkSync(path1);
+  fs.unlinkSync(path2);
+} catch (err) {}
+
+const socket1 = new DgramSocket()
+const socket2 = new DgramSocket()
+
+socket1.bind(path1)
+socket2.bind(path2)
+
+socket2.on('data', (data, remoteAddr) => {
+  console.log(`socket2 received: ${data.toString()}`)
+  // echo
+  socket2.sendTo(data, 0, data.length, remoteAddr);
+})
+
+socket1.on('data', (data) => {
+  console.log(`socket1 received: ${data.toString()}`)
+})
+
+setInterval(() => {
+  const buf = Buffer.from('hello')
+  socket1.sendTo(buf, 0, buf.length, path2)
+}, 1000)
 ```
 
 ## LICENSE
+
+## TODO
+- seqpacket sockets should be closed automatically

docs/classes/SeqpacketSocket.md

@@ -66,7 +66,7 @@ EventEmitter.constructor
 
 #### Defined in
 
-seqpacket.ts:148
+seqpacket.ts:150
 
 ## Methods
 
@@ -92,7 +92,7 @@ However, connect() will throw error synchronously if the 'serverPath' is not a v
 
 #### Defined in
 
-seqpacket.ts:210
+seqpacket.ts:222
 
 ___
 
@@ -108,7 +108,7 @@ Ensures that no more I/O activity happens on this socket. Destroys the stream an
 
 #### Defined in
 
-seqpacket.ts:273
+seqpacket.ts:289
 
 ___
 
@@ -130,7 +130,7 @@ Half-closes the socket. i.e., it sends a FIN packet. It is possible the server w
 
 #### Defined in
 
-seqpacket.ts:232
+seqpacket.ts:248
 
 ___
 
@@ -148,7 +148,7 @@ Default size is 256KB.
 
 #### Defined in
 
-seqpacket.ts:243
+seqpacket.ts:259
 
 ___
 
@@ -164,7 +164,7 @@ Reference the socket so that it will prevent Node.js process from exiting automa
 
 #### Defined in
 
-seqpacket.ts:259
+seqpacket.ts:275
 
 ___
 
@@ -186,7 +186,7 @@ Set the size of buffer that SeqpacketSocket uses to receive data.
 
 #### Defined in
 
-seqpacket.ts:252
+seqpacket.ts:268
 
 ___
 
@@ -202,13 +202,13 @@ Unreference the socket so that it won't prevent Node.js process from exiting aut
 
 #### Defined in
 
-seqpacket.ts:266
+seqpacket.ts:282
 
 ___
 
 ### write
 
-▸ **write**(`buf`, `offset`, `length`, `cb?`): `void`
+▸ **write**(`buf`, `offset?`, `length?`, `cb?`): `void`
 
 Sends data on the socket.
 
@@ -217,8 +217,8 @@ Sends data on the socket.
 | Name | Type |
 | :------ | :------ |
 | `buf` | `Buffer` |
-| `offset` | `number` |
-| `length` | `number` |
+| `offset?` | `number` |
+| `length?` | `number` |
 | `cb?` | [`NotifyCb`](../modules.md#notifycb) |
 
 #### Returns
@@ -227,4 +227,4 @@ Sends data on the socket.
 
 #### Defined in
 
-seqpacket.ts:223
+seqpacket.ts:235