Skip to content

Commit 28f3b80

Browse files
oyydoyyd
committed
chore: use a non-conflict package name
1 parent 5e092f7 commit 28f3b80

File tree

13 files changed

+103
-75
lines changed

13 files changed

+103
-75
lines changed

‎Cargo.lock

Lines changed: 12 additions & 12 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
edition = "2021"
3-
name = "unix-socket"
3+
name = "nix-socket"
44
version = "0.0.0"
55

66
[lib]

‎README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,32 @@
1-
# unix-socket
1+
# nix-socket
2+
3+
`nix-socket` allows you to use some nonblocking sockets that are not supported by Node.js native modules, including:
4+
- unix seqpacket(`SOCK_SEQPACKET`) sockets
5+
- unix datagram(`SOCK_DGRAM`) sockets
6+
- Using `SO_REUSEPORT` for TCP [net.Server](https://nodejs.org/dist/latest-v16.x/docs/api/net.html#class-netserver)
7+
8+
`nix-socket` is a [napi-rs](https://napi.rs/) based [Node.js addons](https://nodejs.org/docs/latest-v16.x/api/addons.html). This lib uses [libuv](https://libuv.org/) inside Node.js so that it won't introduce other asynchronous runtimes.
9+
10+
## Examples
11+
12+
### Seqpacket Sockets
13+
14+
```js
15+
const { SeqpacketServer, SeqpacketSocket } = require('nix-socket')
16+
const os = require('os')
17+
const path = require('path')
18+
19+
const bindPath = path.resolve(os.tmp(), './my.sock')
20+
21+
const server = new SeqpacketServer()
22+
23+
server.listen(bindPath)
24+
25+
const client = new SeqpacketSocket()
26+
27+
// TODO
28+
client.write()
29+
```
230

331
## API Documents
432

‎js/addon.js

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -25,24 +25,24 @@ switch (platform) {
2525
case 'android':
2626
switch (arch) {
2727
case 'arm64':
28-
localFileExisted = existsSync(join(__dirname, '../unix-socket.android-arm64.node'))
28+
localFileExisted = existsSync(join(__dirname, '../nix-socket.android-arm64.node'))
2929
try {
3030
if (localFileExisted) {
31-
nativeBinding = require('../unix-socket.android-arm64.node')
31+
nativeBinding = require('../nix-socket.android-arm64.node')
3232
} else {
33-
nativeBinding = require('unix-socket-android-arm64')
33+
nativeBinding = require('nix-socket-android-arm64')
3434
}
3535
} catch (e) {
3636
loadError = e
3737
}
3838
break
3939
case 'arm':
40-
localFileExisted = existsSync(join(__dirname, '../unix-socket.android-arm-eabi.node'))
40+
localFileExisted = existsSync(join(__dirname, '../nix-socket.android-arm-eabi.node'))
4141
try {
4242
if (localFileExisted) {
43-
nativeBinding = require('../unix-socket.android-arm-eabi.node')
43+
nativeBinding = require('../nix-socket.android-arm-eabi.node')
4444
} else {
45-
nativeBinding = require('unix-socket-android-arm-eabi')
45+
nativeBinding = require('nix-socket-android-arm-eabi')
4646
}
4747
} catch (e) {
4848
loadError = e
@@ -56,41 +56,41 @@ switch (platform) {
5656
switch (arch) {
5757
case 'x64':
5858
localFileExisted = existsSync(
59-
join(__dirname, '../unix-socket.win32-x64-msvc.node')
59+
join(__dirname, '../nix-socket.win32-x64-msvc.node')
6060
)
6161
try {
6262
if (localFileExisted) {
63-
nativeBinding = require('../unix-socket.win32-x64-msvc.node')
63+
nativeBinding = require('../nix-socket.win32-x64-msvc.node')
6464
} else {
65-
nativeBinding = require('unix-socket-win32-x64-msvc')
65+
nativeBinding = require('nix-socket-win32-x64-msvc')
6666
}
6767
} catch (e) {
6868
loadError = e
6969
}
7070
break
7171
case 'ia32':
7272
localFileExisted = existsSync(
73-
join(__dirname, '../unix-socket.win32-ia32-msvc.node')
73+
join(__dirname, '../nix-socket.win32-ia32-msvc.node')
7474
)
7575
try {
7676
if (localFileExisted) {
77-
nativeBinding = require('../unix-socket.win32-ia32-msvc.node')
77+
nativeBinding = require('../nix-socket.win32-ia32-msvc.node')
7878
} else {
79-
nativeBinding = require('unix-socket-win32-ia32-msvc')
79+
nativeBinding = require('nix-socket-win32-ia32-msvc')
8080
}
8181
} catch (e) {
8282
loadError = e
8383
}
8484
break
8585
case 'arm64':
8686
localFileExisted = existsSync(
87-
join(__dirname, '../unix-socket.win32-arm64-msvc.node')
87+
join(__dirname, '../nix-socket.win32-arm64-msvc.node')
8888
)
8989
try {
9090
if (localFileExisted) {
91-
nativeBinding = require('../unix-socket.win32-arm64-msvc.node')
91+
nativeBinding = require('../nix-socket.win32-arm64-msvc.node')
9292
} else {
93-
nativeBinding = require('unix-socket-win32-arm64-msvc')
93+
nativeBinding = require('nix-socket-win32-arm64-msvc')
9494
}
9595
} catch (e) {
9696
loadError = e
@@ -103,26 +103,26 @@ switch (platform) {
103103
case 'darwin':
104104
switch (arch) {
105105
case 'x64':
106-
localFileExisted = existsSync(join(__dirname, '../unix-socket.darwin-x64.node'))
106+
localFileExisted = existsSync(join(__dirname, '../nix-socket.darwin-x64.node'))
107107
try {
108108
if (localFileExisted) {
109-
nativeBinding = require('../unix-socket.darwin-x64.node')
109+
nativeBinding = require('../nix-socket.darwin-x64.node')
110110
} else {
111-
nativeBinding = require('unix-socket-darwin-x64')
111+
nativeBinding = require('nix-socket-darwin-x64')
112112
}
113113
} catch (e) {
114114
loadError = e
115115
}
116116
break
117117
case 'arm64':
118118
localFileExisted = existsSync(
119-
join(__dirname, '../unix-socket.darwin-arm64.node')
119+
join(__dirname, '../nix-socket.darwin-arm64.node')
120120
)
121121
try {
122122
if (localFileExisted) {
123-
nativeBinding = require('../unix-socket.darwin-arm64.node')
123+
nativeBinding = require('../nix-socket.darwin-arm64.node')
124124
} else {
125-
nativeBinding = require('unix-socket-darwin-arm64')
125+
nativeBinding = require('nix-socket-darwin-arm64')
126126
}
127127
} catch (e) {
128128
loadError = e
@@ -136,12 +136,12 @@ switch (platform) {
136136
if (arch !== 'x64') {
137137
throw new Error(`Unsupported architecture on FreeBSD: ${arch}`)
138138
}
139-
localFileExisted = existsSync(join(__dirname, '../unix-socket.freebsd-x64.node'))
139+
localFileExisted = existsSync(join(__dirname, '../nix-socket.freebsd-x64.node'))
140140
try {
141141
if (localFileExisted) {
142-
nativeBinding = require('../unix-socket.freebsd-x64.node')
142+
nativeBinding = require('../nix-socket.freebsd-x64.node')
143143
} else {
144-
nativeBinding = require('unix-socket-freebsd-x64')
144+
nativeBinding = require('nix-socket-freebsd-x64')
145145
}
146146
} catch (e) {
147147
loadError = e
@@ -152,26 +152,26 @@ switch (platform) {
152152
case 'x64':
153153
if (isMusl()) {
154154
localFileExisted = existsSync(
155-
join(__dirname, '../unix-socket.linux-x64-musl.node')
155+
join(__dirname, '../nix-socket.linux-x64-musl.node')
156156
)
157157
try {
158158
if (localFileExisted) {
159-
nativeBinding = require('../unix-socket.linux-x64-musl.node')
159+
nativeBinding = require('../nix-socket.linux-x64-musl.node')
160160
} else {
161-
nativeBinding = require('unix-socket-linux-x64-musl')
161+
nativeBinding = require('nix-socket-linux-x64-musl')
162162
}
163163
} catch (e) {
164164
loadError = e
165165
}
166166
} else {
167167
localFileExisted = existsSync(
168-
join(__dirname, '../unix-socket.linux-x64-gnu.node')
168+
join(__dirname, '../nix-socket.linux-x64-gnu.node')
169169
)
170170
try {
171171
if (localFileExisted) {
172-
nativeBinding = require('../unix-socket.linux-x64-gnu.node')
172+
nativeBinding = require('../nix-socket.linux-x64-gnu.node')
173173
} else {
174-
nativeBinding = require('unix-socket-linux-x64-gnu')
174+
nativeBinding = require('nix-socket-linux-x64-gnu')
175175
}
176176
} catch (e) {
177177
loadError = e
@@ -181,26 +181,26 @@ switch (platform) {
181181
case 'arm64':
182182
if (isMusl()) {
183183
localFileExisted = existsSync(
184-
join(__dirname, '../unix-socket.linux-arm64-musl.node')
184+
join(__dirname, '../nix-socket.linux-arm64-musl.node')
185185
)
186186
try {
187187
if (localFileExisted) {
188-
nativeBinding = require('../unix-socket.linux-arm64-musl.node')
188+
nativeBinding = require('../nix-socket.linux-arm64-musl.node')
189189
} else {
190-
nativeBinding = require('unix-socket-linux-arm64-musl')
190+
nativeBinding = require('nix-socket-linux-arm64-musl')
191191
}
192192
} catch (e) {
193193
loadError = e
194194
}
195195
} else {
196196
localFileExisted = existsSync(
197-
join(__dirname, '../unix-socket.linux-arm64-gnu.node')
197+
join(__dirname, '../nix-socket.linux-arm64-gnu.node')
198198
)
199199
try {
200200
if (localFileExisted) {
201-
nativeBinding = require('../unix-socket.linux-arm64-gnu.node')
201+
nativeBinding = require('../nix-socket.linux-arm64-gnu.node')
202202
} else {
203-
nativeBinding = require('unix-socket-linux-arm64-gnu')
203+
nativeBinding = require('nix-socket-linux-arm64-gnu')
204204
}
205205
} catch (e) {
206206
loadError = e
@@ -209,13 +209,13 @@ switch (platform) {
209209
break
210210
case 'arm':
211211
localFileExisted = existsSync(
212-
join(__dirname, '../unix-socket.linux-arm-gnueabihf.node')
212+
join(__dirname, '../nix-socket.linux-arm-gnueabihf.node')
213213
)
214214
try {
215215
if (localFileExisted) {
216-
nativeBinding = require('../unix-socket.linux-arm-gnueabihf.node')
216+
nativeBinding = require('../nix-socket.linux-arm-gnueabihf.node')
217217
} else {
218-
nativeBinding = require('unix-socket-linux-arm-gnueabihf')
218+
nativeBinding = require('nix-socket-linux-arm-gnueabihf')
219219
}
220220
} catch (e) {
221221
loadError = e

‎npm/darwin-arm64/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# `unix-socket-darwin-arm64`
1+
# `nix-socket-darwin-arm64`
22

3-
This is the **aarch64-apple-darwin** binary for `unix-socket`
3+
This is the **aarch64-apple-darwin** binary for `nix-socket`

‎npm/darwin-arm64/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
{
2-
"name": "unix-socket-darwin-arm64",
2+
"name": "nix-socket-darwin-arm64",
33
"version": "0.0.0",
44
"os": [
55
"darwin"
66
],
77
"cpu": [
88
"arm64"
99
],
10-
"main": "unix-socket.darwin-arm64.node",
10+
"main": "nix-socket.darwin-arm64.node",
1111
"files": [
12-
"unix-socket.darwin-arm64.node"
12+
"nix-socket.darwin-arm64.node"
1313
],
1414
"license": "MIT",
1515
"engines": {

‎npm/darwin-x64/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# `unix-socket-darwin-x64`
1+
# `nix-socket-darwin-x64`
22

3-
This is the **x86_64-apple-darwin** binary for `unix-socket`
3+
This is the **x86_64-apple-darwin** binary for `nix-socket`

‎npm/darwin-x64/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
{
2-
"name": "unix-socket-darwin-x64",
2+
"name": "nix-socket-darwin-x64",
33
"version": "0.0.0",
44
"os": [
55
"darwin"
66
],
77
"cpu": [
88
"x64"
99
],
10-
"main": "unix-socket.darwin-x64.node",
10+
"main": "nix-socket.darwin-x64.node",
1111
"files": [
12-
"unix-socket.darwin-x64.node"
12+
"nix-socket.darwin-x64.node"
1313
],
1414
"license": "MIT",
1515
"engines": {

‎npm/linux-x64-gnu/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# `unix-socket-linux-x64-gnu`
1+
# `nix-socket-linux-x64-gnu`
22

3-
This is the **x86_64-unknown-linux-gnu** binary for `unix-socket`
3+
This is the **x86_64-unknown-linux-gnu** binary for `nix-socket`

‎npm/linux-x64-gnu/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
{
2-
"name": "unix-socket-linux-x64-gnu",
2+
"name": "nix-socket-linux-x64-gnu",
33
"version": "0.0.0",
44
"os": [
55
"linux"
66
],
77
"cpu": [
88
"x64"
99
],
10-
"main": "unix-socket.linux-x64-gnu.node",
10+
"main": "nix-socket.linux-x64-gnu.node",
1111
"files": [
12-
"unix-socket.linux-x64-gnu.node"
12+
"nix-socket.linux-x64-gnu.node"
1313
],
1414
"license": "MIT",
1515
"engines": {

0 commit comments

Comments
 (0)