sabcom 0.0.1 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +122 -0
- package/build/index.cjs +2 -2
- package/build/index.cjs.map +1 -1
- package/build/index.d.ts +5 -2
- package/build/index.js +2 -2
- package/build/index.js.map +1 -1
- package/package.json +16 -3
- package/src/index.ts +8 -2
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
The MIT License (MIT)
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Ivan Zakharchanka
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
# SABCOM
|
|
2
|
+
|
|
3
|
+
[![Github Build Status][github-image]][github-url]
|
|
4
|
+
[![NPM version][npm-image]][npm-url]
|
|
5
|
+
[![Downloads][downloads-image]][npm-url]
|
|
6
|
+
[![Coverage Status][codecov-image]][codecov-url]
|
|
7
|
+
[![Snyk][snyk-image]][snyk-url]
|
|
8
|
+
|
|
9
|
+
A TypeScript/Node.js library for inter-thread communication using SharedArrayBuffer with atomic operations and V8 serialization.
|
|
10
|
+
|
|
11
|
+
## Features
|
|
12
|
+
|
|
13
|
+
- **Thread-safe communication** using atomic operations
|
|
14
|
+
- **Chunked data transfer** for large payloads
|
|
15
|
+
- **V8 serialization** for complex data types
|
|
16
|
+
- **Timeout handling** with configurable timeouts
|
|
17
|
+
- **Zero-copy operations** where possible
|
|
18
|
+
|
|
19
|
+
## Installation
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npm install sabcom
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Usage
|
|
26
|
+
|
|
27
|
+
### Basic Example
|
|
28
|
+
|
|
29
|
+
```typescript
|
|
30
|
+
import { write, read } from 'sabcom';
|
|
31
|
+
|
|
32
|
+
// Create a shared buffer (1MB)
|
|
33
|
+
const buffer = new SharedArrayBuffer(1024 * 1024);
|
|
34
|
+
|
|
35
|
+
// Writer thread
|
|
36
|
+
const data = { message: 'Hello World', numbers: [1, 2, 3, 4, 5] };
|
|
37
|
+
write(data, buffer);
|
|
38
|
+
|
|
39
|
+
// Reader thread
|
|
40
|
+
const received = read(buffer);
|
|
41
|
+
console.log(received); // { message: 'Hello World', numbers: [1, 2, 3, 4, 5] }
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### With Custom Timeout
|
|
45
|
+
|
|
46
|
+
```typescript
|
|
47
|
+
// 10 second timeout
|
|
48
|
+
write(data, buffer, 10000);
|
|
49
|
+
const received = read(buffer, 10000);
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## API Reference
|
|
53
|
+
|
|
54
|
+
### `write(data: unknown, buffer: SharedArrayBuffer, timeout?: number): void`
|
|
55
|
+
|
|
56
|
+
Writes data to the shared buffer using chunked transfer.
|
|
57
|
+
|
|
58
|
+
- `data` - Any serializable data
|
|
59
|
+
- `buffer` - SharedArrayBuffer for communication
|
|
60
|
+
- `timeout` - Timeout in milliseconds (default: 5000)
|
|
61
|
+
|
|
62
|
+
**Throws:**
|
|
63
|
+
- `Error` - On handshake or chunk timeout
|
|
64
|
+
|
|
65
|
+
### `read(buffer: SharedArrayBuffer, timeout?: number): unknown`
|
|
66
|
+
|
|
67
|
+
Reads data from the shared buffer.
|
|
68
|
+
|
|
69
|
+
- `buffer` - SharedArrayBuffer for communication
|
|
70
|
+
- `timeout` - Timeout in milliseconds (default: 5000)
|
|
71
|
+
|
|
72
|
+
**Returns:** Deserialized data
|
|
73
|
+
|
|
74
|
+
**Throws:**
|
|
75
|
+
- `Error` - On timeout or integrity failure
|
|
76
|
+
|
|
77
|
+
## Protocol
|
|
78
|
+
|
|
79
|
+
The library uses a header-based protocol with atomic operations:
|
|
80
|
+
|
|
81
|
+
1. **READY** - Buffer available for new transfer
|
|
82
|
+
2. **HANDSHAKE** - Writer sends total size and chunk count
|
|
83
|
+
3. **PAYLOAD** - Chunked data transfer with integrity checks
|
|
84
|
+
|
|
85
|
+
### Buffer Layout
|
|
86
|
+
|
|
87
|
+
```
|
|
88
|
+
[Header: 4 * HEADER_VALUES bytes] [Payload: remaining bytes]
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
## Error Handling
|
|
92
|
+
|
|
93
|
+
- **Handshake timeout** - Reader not ready within timeout
|
|
94
|
+
- **Chunk timeout** - Individual chunk transfer timeout
|
|
95
|
+
- **Integrity failure** - Chunk index mismatch
|
|
96
|
+
- **Invalid state** - Unexpected semaphore state
|
|
97
|
+
|
|
98
|
+
## Thread Safety
|
|
99
|
+
|
|
100
|
+
Uses `Atomics.wait()`, `Atomics.notify()`, and `Atomics.store()` for synchronization. Requires SharedArrayBuffer support and proper threading context.
|
|
101
|
+
|
|
102
|
+
## Requirements
|
|
103
|
+
|
|
104
|
+
- Node.js with SharedArrayBuffer support
|
|
105
|
+
- Multi-threaded environment (Worker threads, etc.)
|
|
106
|
+
- V8 engine for serialization
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
## License
|
|
110
|
+
|
|
111
|
+
License [The MIT License](./LICENSE)
|
|
112
|
+
Copyright (c) 2025 Ivan Zakharchanka
|
|
113
|
+
|
|
114
|
+
[npm-url]: https://www.npmjs.com/package/sabcom
|
|
115
|
+
[downloads-image]: https://img.shields.io/npm/dw/sabcom.svg?maxAge=43200
|
|
116
|
+
[npm-image]: https://img.shields.io/npm/v/sabcom.svg?maxAge=43200
|
|
117
|
+
[github-url]: https://github.com/3axap4eHko/sabcom/actions
|
|
118
|
+
[github-image]: https://github.com/3axap4eHko/sabcom/actions/workflows/build.yml/badge.svg?branch=master
|
|
119
|
+
[codecov-url]: https://codecov.io/gh/3axap4eHko/sabcom
|
|
120
|
+
[codecov-image]: https://codecov.io/gh/3axap4eHko/sabcom/branch/master/graph/badge.svg?maxAge=43200
|
|
121
|
+
[snyk-url]: https://snyk.io/test/npm/sabcom/latest
|
|
122
|
+
[snyk-image]: https://snyk.io/test/github/3axap4eHko/sabcom/badge.svg?maxAge=43200
|
package/build/index.cjs
CHANGED
|
@@ -55,7 +55,7 @@ var Header = /*#__PURE__*/ function(Header) {
|
|
|
55
55
|
}({});
|
|
56
56
|
const HEADER_VALUES = 1 + Math.max(Object.values(Handshake).length, Object.values(Header).length) / 2;
|
|
57
57
|
const HEADER_SIZE = Uint32Array.BYTES_PER_ELEMENT * HEADER_VALUES;
|
|
58
|
-
const write = (data, buffer, timeout = 5000)=>{
|
|
58
|
+
const write = (data, buffer, { timeout = 5000 } = {})=>{
|
|
59
59
|
const serialized = (0, _nodev8.serialize)(data);
|
|
60
60
|
const chunkSize = buffer.byteLength - HEADER_SIZE;
|
|
61
61
|
const totalSize = serialized.length;
|
|
@@ -88,7 +88,7 @@ const write = (data, buffer, timeout = 5000)=>{
|
|
|
88
88
|
Atomics.store(header, SEMAPHORE, 0);
|
|
89
89
|
}
|
|
90
90
|
};
|
|
91
|
-
const read = (buffer, timeout = 5000)=>{
|
|
91
|
+
const read = (buffer, { timeout = 5000 } = {})=>{
|
|
92
92
|
const header = new Int32Array(buffer);
|
|
93
93
|
if (Atomics.wait(header, SEMAPHORE, 0, timeout) === "timed-out") {
|
|
94
94
|
throw new Error("Handshake timeout");
|
package/build/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { serialize, deserialize } from \"node:v8\";\n\nexport const SEMAPHORE = 0;\n\nexport enum Semaphore {\n READY,\n HANDSHAKE,\n PAYLOAD,\n}\n\nexport enum Handshake {\n TOTAL_SIZE = 1,\n TOTAL_CHUNKS,\n}\n\nexport enum Header {\n CHUNK_INDEX = 1,\n CHUNK_OFFSET,\n CHUNK_SIZE,\n}\n\nexport const HEADER_VALUES =\n 1 +\n Math.max(Object.values(Handshake).length, Object.values(Header).length) / 2;\nexport const HEADER_SIZE = Uint32Array.BYTES_PER_ELEMENT * HEADER_VALUES;\n\nexport const write = (\n data: unknown,\n buffer: SharedArrayBuffer,\n timeout = 5000
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { serialize, deserialize } from \"node:v8\";\n\nexport const SEMAPHORE = 0;\n\nexport enum Semaphore {\n READY,\n HANDSHAKE,\n PAYLOAD,\n}\n\nexport enum Handshake {\n TOTAL_SIZE = 1,\n TOTAL_CHUNKS,\n}\n\nexport enum Header {\n CHUNK_INDEX = 1,\n CHUNK_OFFSET,\n CHUNK_SIZE,\n}\n\nexport const HEADER_VALUES =\n 1 +\n Math.max(Object.values(Handshake).length, Object.values(Header).length) / 2;\nexport const HEADER_SIZE = Uint32Array.BYTES_PER_ELEMENT * HEADER_VALUES;\n\nexport interface Options {\n timeout?: number;\n}\n\nexport const write = (\n data: unknown,\n buffer: SharedArrayBuffer,\n { timeout = 5000 }: Options = {}\n) => {\n const serialized = serialize(data);\n const chunkSize = buffer.byteLength - HEADER_SIZE;\n const totalSize = serialized.length;\n const totalChunks = Math.ceil(totalSize / chunkSize);\n\n const header = new Int32Array(buffer);\n header[Handshake.TOTAL_SIZE] = totalSize;\n header[Handshake.TOTAL_CHUNKS] = totalChunks;\n\n Atomics.store(header, SEMAPHORE, Semaphore.HANDSHAKE);\n Atomics.notify(header, SEMAPHORE);\n\n try {\n if (\n Atomics.wait(header, SEMAPHORE, Semaphore.HANDSHAKE, timeout) ===\n \"timed-out\"\n ) {\n throw new Error(\"Reader handshake timeout\");\n }\n\n const payload = new Uint8Array(buffer, HEADER_SIZE);\n\n for (let i = 0; i < totalChunks; i++) {\n const start = i * chunkSize;\n const end = Math.min(start + chunkSize, totalSize);\n const size = end - start;\n\n payload.set(serialized.subarray(start, end), 0);\n\n header[Header.CHUNK_INDEX] = i;\n header[Header.CHUNK_OFFSET] = start;\n header[Header.CHUNK_SIZE] = size;\n\n Atomics.store(header, SEMAPHORE, Semaphore.PAYLOAD);\n Atomics.notify(header, SEMAPHORE);\n\n if (\n Atomics.wait(header, SEMAPHORE, Semaphore.PAYLOAD, timeout) ===\n \"timed-out\"\n ) {\n throw new Error(`Reader timeout on chunk ${i}/${totalChunks - 1}`);\n }\n }\n } finally {\n Atomics.store(header, SEMAPHORE, Semaphore.READY);\n }\n};\n\nexport const read = (buffer: SharedArrayBuffer,\n { timeout = 5000 }: Options = {}\n): unknown => {\n const header = new Int32Array(buffer);\n if (\n Atomics.wait(header, SEMAPHORE, Semaphore.READY, timeout) === \"timed-out\"\n ) {\n throw new Error(\"Handshake timeout\");\n }\n if (header[SEMAPHORE] !== Semaphore.HANDSHAKE) {\n throw new Error(\"Invalid handshake state\");\n }\n\n const totalSize = header[Handshake.TOTAL_SIZE];\n const totalChunks = header[Handshake.TOTAL_CHUNKS];\n const data = new Uint8Array(totalSize);\n\n Atomics.store(header, SEMAPHORE, Semaphore.READY);\n Atomics.notify(header, SEMAPHORE);\n\n const payload = new Uint8Array(buffer, HEADER_SIZE);\n for (let i = 0; i < totalChunks; i++) {\n if (\n Atomics.wait(header, SEMAPHORE, Semaphore.READY, timeout) === \"timed-out\"\n ) {\n throw new Error(`Writer timeout waiting for chunk ${i}`);\n }\n // @ts-expect-error does not infer number\n if (header[SEMAPHORE] !== Semaphore.PAYLOAD) {\n throw new Error(\n `Expected payload header, received ${Semaphore[header[SEMAPHORE]]}`,\n );\n }\n const chunkIndex = header[Header.CHUNK_INDEX];\n if (i !== chunkIndex) {\n throw new Error(\n `Reader integrity failure for chunk ${chunkIndex} expected ${i}`,\n );\n }\n const offset = header[Header.CHUNK_OFFSET];\n const size = header[Header.CHUNK_SIZE];\n data.set(payload.subarray(0, size), offset);\n Atomics.store(header, SEMAPHORE, Semaphore.READY);\n Atomics.notify(header, SEMAPHORE);\n }\n return deserialize(data);\n};\n"],"names":["HEADER_SIZE","HEADER_VALUES","Handshake","Header","SEMAPHORE","Semaphore","read","write","Math","max","Object","values","length","Uint32Array","BYTES_PER_ELEMENT","data","buffer","timeout","serialized","serialize","chunkSize","byteLength","totalSize","totalChunks","ceil","header","Int32Array","Atomics","store","notify","wait","Error","payload","Uint8Array","i","start","end","min","size","set","subarray","chunkIndex","offset","deserialize"],"mappings":";;;;;;;;;;;QAwBaA;eAAAA;;QAHAC;eAAAA;;QAXDC;eAAAA;;QAKAC;eAAAA;;QAbCC;eAAAA;;QAEDC;eAAAA;;QA+ECC;eAAAA;;QArDAC;eAAAA;;;wBA9B0B;AAEhC,MAAMH,YAAY;AAElB,IAAA,AAAKC,mCAAAA;;;;WAAAA;;AAML,IAAA,AAAKH,mCAAAA;;;WAAAA;;AAKL,IAAA,AAAKC,gCAAAA;;;;WAAAA;;AAML,MAAMF,gBACX,IACAO,KAAKC,GAAG,CAACC,OAAOC,MAAM,CAACT,WAAWU,MAAM,EAAEF,OAAOC,MAAM,CAACR,QAAQS,MAAM,IAAI;AACrE,MAAMZ,cAAca,YAAYC,iBAAiB,GAAGb;AAMpD,MAAMM,QAAQ,CACnBQ,MACAC,QACA,EAAEC,UAAU,IAAI,EAAW,GAAG,CAAC,CAAC;IAEhC,MAAMC,aAAaC,IAAAA,iBAAS,EAACJ;IAC7B,MAAMK,YAAYJ,OAAOK,UAAU,GAAGrB;IACtC,MAAMsB,YAAYJ,WAAWN,MAAM;IACnC,MAAMW,cAAcf,KAAKgB,IAAI,CAACF,YAAYF;IAE1C,MAAMK,SAAS,IAAIC,WAAWV;IAC9BS,MAAM,GAAsB,GAAGH;IAC/BG,MAAM,GAAwB,GAAGF;IAEjCI,QAAQC,KAAK,CAACH,QAAQrB;IACtBuB,QAAQE,MAAM,CAACJ,QAAQrB;IAEvB,IAAI;QACF,IACEuB,QAAQG,IAAI,CAACL,QAAQrB,cAAgCa,aACrD,aACA;YACA,MAAM,IAAIc,MAAM;QAClB;QAEA,MAAMC,UAAU,IAAIC,WAAWjB,QAAQhB;QAEvC,IAAK,IAAIkC,IAAI,GAAGA,IAAIX,aAAaW,IAAK;YACpC,MAAMC,QAAQD,IAAId;YAClB,MAAMgB,MAAM5B,KAAK6B,GAAG,CAACF,QAAQf,WAAWE;YACxC,MAAMgB,OAAOF,MAAMD;YAEnBH,QAAQO,GAAG,CAACrB,WAAWsB,QAAQ,CAACL,OAAOC,MAAM;YAE7CX,MAAM,GAAoB,GAAGS;YAC7BT,MAAM,GAAqB,GAAGU;YAC9BV,MAAM,GAAmB,GAAGa;YAE5BX,QAAQC,KAAK,CAACH,QAAQrB;YACtBuB,QAAQE,MAAM,CAACJ,QAAQrB;YAEvB,IACEuB,QAAQG,IAAI,CAACL,QAAQrB,cAA8Ba,aACnD,aACA;gBACA,MAAM,IAAIc,MAAM,CAAC,wBAAwB,EAAEG,EAAE,CAAC,EAAEX,cAAc,GAAG;YACnE;QACF;IACF,SAAU;QACRI,QAAQC,KAAK,CAACH,QAAQrB;IACxB;AACF;AAEO,MAAME,OAAO,CAACU,QACnB,EAAEC,UAAU,IAAI,EAAW,GAAG,CAAC,CAAC;IAEhC,MAAMQ,SAAS,IAAIC,WAAWV;IAC9B,IACEW,QAAQG,IAAI,CAACL,QAAQrB,cAA4Ba,aAAa,aAC9D;QACA,MAAM,IAAIc,MAAM;IAClB;IACA,IAAIN,MAAM,CAACrB,UAAU,QAA0B;QAC7C,MAAM,IAAI2B,MAAM;IAClB;IAEA,MAAMT,YAAYG,MAAM,GAAsB;IAC9C,MAAMF,cAAcE,MAAM,GAAwB;IAClD,MAAMV,OAAO,IAAIkB,WAAWX;IAE5BK,QAAQC,KAAK,CAACH,QAAQrB;IACtBuB,QAAQE,MAAM,CAACJ,QAAQrB;IAEvB,MAAM4B,UAAU,IAAIC,WAAWjB,QAAQhB;IACvC,IAAK,IAAIkC,IAAI,GAAGA,IAAIX,aAAaW,IAAK;QACpC,IACEP,QAAQG,IAAI,CAACL,QAAQrB,cAA4Ba,aAAa,aAC9D;YACA,MAAM,IAAIc,MAAM,CAAC,iCAAiC,EAAEG,GAAG;QACzD;QAEA,IAAIT,MAAM,CAACrB,UAAU,QAAwB;YAC3C,MAAM,IAAI2B,MACR,CAAC,kCAAkC,EAAE1B,SAAS,CAACoB,MAAM,CAACrB,UAAU,CAAC,EAAE;QAEvE;QACA,MAAMqC,aAAahB,MAAM,GAAoB;QAC7C,IAAIS,MAAMO,YAAY;YACpB,MAAM,IAAIV,MACR,CAAC,mCAAmC,EAAEU,WAAW,UAAU,EAAEP,GAAG;QAEpE;QACA,MAAMQ,SAASjB,MAAM,GAAqB;QAC1C,MAAMa,OAAOb,MAAM,GAAmB;QACtCV,KAAKwB,GAAG,CAACP,QAAQQ,QAAQ,CAAC,GAAGF,OAAOI;QACpCf,QAAQC,KAAK,CAACH,QAAQrB;QACtBuB,QAAQE,MAAM,CAACJ,QAAQrB;IACzB;IACA,OAAOuC,IAAAA,mBAAW,EAAC5B;AACrB"}
|
package/build/index.d.ts
CHANGED
|
@@ -15,5 +15,8 @@ export declare enum Header {
|
|
|
15
15
|
}
|
|
16
16
|
export declare const HEADER_VALUES: number;
|
|
17
17
|
export declare const HEADER_SIZE: number;
|
|
18
|
-
export
|
|
19
|
-
|
|
18
|
+
export interface Options {
|
|
19
|
+
timeout?: number;
|
|
20
|
+
}
|
|
21
|
+
export declare const write: (data: unknown, buffer: SharedArrayBuffer, { timeout }?: Options) => void;
|
|
22
|
+
export declare const read: (buffer: SharedArrayBuffer, { timeout }?: Options) => unknown;
|
package/build/index.js
CHANGED
|
@@ -19,7 +19,7 @@ export var Header = /*#__PURE__*/ function(Header) {
|
|
|
19
19
|
}({});
|
|
20
20
|
export const HEADER_VALUES = 1 + Math.max(Object.values(Handshake).length, Object.values(Header).length) / 2;
|
|
21
21
|
export const HEADER_SIZE = Uint32Array.BYTES_PER_ELEMENT * HEADER_VALUES;
|
|
22
|
-
export const write = (data, buffer, timeout = 5000)=>{
|
|
22
|
+
export const write = (data, buffer, { timeout = 5000 } = {})=>{
|
|
23
23
|
const serialized = serialize(data);
|
|
24
24
|
const chunkSize = buffer.byteLength - HEADER_SIZE;
|
|
25
25
|
const totalSize = serialized.length;
|
|
@@ -52,7 +52,7 @@ export const write = (data, buffer, timeout = 5000)=>{
|
|
|
52
52
|
Atomics.store(header, SEMAPHORE, 0);
|
|
53
53
|
}
|
|
54
54
|
};
|
|
55
|
-
export const read = (buffer, timeout = 5000)=>{
|
|
55
|
+
export const read = (buffer, { timeout = 5000 } = {})=>{
|
|
56
56
|
const header = new Int32Array(buffer);
|
|
57
57
|
if (Atomics.wait(header, SEMAPHORE, 0, timeout) === "timed-out") {
|
|
58
58
|
throw new Error("Handshake timeout");
|
package/build/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { serialize, deserialize } from \"node:v8\";\n\nexport const SEMAPHORE = 0;\n\nexport enum Semaphore {\n READY,\n HANDSHAKE,\n PAYLOAD,\n}\n\nexport enum Handshake {\n TOTAL_SIZE = 1,\n TOTAL_CHUNKS,\n}\n\nexport enum Header {\n CHUNK_INDEX = 1,\n CHUNK_OFFSET,\n CHUNK_SIZE,\n}\n\nexport const HEADER_VALUES =\n 1 +\n Math.max(Object.values(Handshake).length, Object.values(Header).length) / 2;\nexport const HEADER_SIZE = Uint32Array.BYTES_PER_ELEMENT * HEADER_VALUES;\n\nexport const write = (\n data: unknown,\n buffer: SharedArrayBuffer,\n timeout = 5000
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { serialize, deserialize } from \"node:v8\";\n\nexport const SEMAPHORE = 0;\n\nexport enum Semaphore {\n READY,\n HANDSHAKE,\n PAYLOAD,\n}\n\nexport enum Handshake {\n TOTAL_SIZE = 1,\n TOTAL_CHUNKS,\n}\n\nexport enum Header {\n CHUNK_INDEX = 1,\n CHUNK_OFFSET,\n CHUNK_SIZE,\n}\n\nexport const HEADER_VALUES =\n 1 +\n Math.max(Object.values(Handshake).length, Object.values(Header).length) / 2;\nexport const HEADER_SIZE = Uint32Array.BYTES_PER_ELEMENT * HEADER_VALUES;\n\nexport interface Options {\n timeout?: number;\n}\n\nexport const write = (\n data: unknown,\n buffer: SharedArrayBuffer,\n { timeout = 5000 }: Options = {}\n) => {\n const serialized = serialize(data);\n const chunkSize = buffer.byteLength - HEADER_SIZE;\n const totalSize = serialized.length;\n const totalChunks = Math.ceil(totalSize / chunkSize);\n\n const header = new Int32Array(buffer);\n header[Handshake.TOTAL_SIZE] = totalSize;\n header[Handshake.TOTAL_CHUNKS] = totalChunks;\n\n Atomics.store(header, SEMAPHORE, Semaphore.HANDSHAKE);\n Atomics.notify(header, SEMAPHORE);\n\n try {\n if (\n Atomics.wait(header, SEMAPHORE, Semaphore.HANDSHAKE, timeout) ===\n \"timed-out\"\n ) {\n throw new Error(\"Reader handshake timeout\");\n }\n\n const payload = new Uint8Array(buffer, HEADER_SIZE);\n\n for (let i = 0; i < totalChunks; i++) {\n const start = i * chunkSize;\n const end = Math.min(start + chunkSize, totalSize);\n const size = end - start;\n\n payload.set(serialized.subarray(start, end), 0);\n\n header[Header.CHUNK_INDEX] = i;\n header[Header.CHUNK_OFFSET] = start;\n header[Header.CHUNK_SIZE] = size;\n\n Atomics.store(header, SEMAPHORE, Semaphore.PAYLOAD);\n Atomics.notify(header, SEMAPHORE);\n\n if (\n Atomics.wait(header, SEMAPHORE, Semaphore.PAYLOAD, timeout) ===\n \"timed-out\"\n ) {\n throw new Error(`Reader timeout on chunk ${i}/${totalChunks - 1}`);\n }\n }\n } finally {\n Atomics.store(header, SEMAPHORE, Semaphore.READY);\n }\n};\n\nexport const read = (buffer: SharedArrayBuffer,\n { timeout = 5000 }: Options = {}\n): unknown => {\n const header = new Int32Array(buffer);\n if (\n Atomics.wait(header, SEMAPHORE, Semaphore.READY, timeout) === \"timed-out\"\n ) {\n throw new Error(\"Handshake timeout\");\n }\n if (header[SEMAPHORE] !== Semaphore.HANDSHAKE) {\n throw new Error(\"Invalid handshake state\");\n }\n\n const totalSize = header[Handshake.TOTAL_SIZE];\n const totalChunks = header[Handshake.TOTAL_CHUNKS];\n const data = new Uint8Array(totalSize);\n\n Atomics.store(header, SEMAPHORE, Semaphore.READY);\n Atomics.notify(header, SEMAPHORE);\n\n const payload = new Uint8Array(buffer, HEADER_SIZE);\n for (let i = 0; i < totalChunks; i++) {\n if (\n Atomics.wait(header, SEMAPHORE, Semaphore.READY, timeout) === \"timed-out\"\n ) {\n throw new Error(`Writer timeout waiting for chunk ${i}`);\n }\n // @ts-expect-error does not infer number\n if (header[SEMAPHORE] !== Semaphore.PAYLOAD) {\n throw new Error(\n `Expected payload header, received ${Semaphore[header[SEMAPHORE]]}`,\n );\n }\n const chunkIndex = header[Header.CHUNK_INDEX];\n if (i !== chunkIndex) {\n throw new Error(\n `Reader integrity failure for chunk ${chunkIndex} expected ${i}`,\n );\n }\n const offset = header[Header.CHUNK_OFFSET];\n const size = header[Header.CHUNK_SIZE];\n data.set(payload.subarray(0, size), offset);\n Atomics.store(header, SEMAPHORE, Semaphore.READY);\n Atomics.notify(header, SEMAPHORE);\n }\n return deserialize(data);\n};\n"],"names":["serialize","deserialize","SEMAPHORE","Semaphore","Handshake","Header","HEADER_VALUES","Math","max","Object","values","length","HEADER_SIZE","Uint32Array","BYTES_PER_ELEMENT","write","data","buffer","timeout","serialized","chunkSize","byteLength","totalSize","totalChunks","ceil","header","Int32Array","Atomics","store","notify","wait","Error","payload","Uint8Array","i","start","end","min","size","set","subarray","read","chunkIndex","offset"],"mappings":"AAAA,SAASA,SAAS,EAAEC,WAAW,QAAQ,UAAU;AAEjD,OAAO,MAAMC,YAAY,EAAE;AAE3B,OAAO,IAAA,AAAKC,mCAAAA;;;;WAAAA;MAIX;AAED,OAAO,IAAA,AAAKC,mCAAAA;;;WAAAA;MAGX;AAED,OAAO,IAAA,AAAKC,gCAAAA;;;;WAAAA;MAIX;AAED,OAAO,MAAMC,gBACX,IACAC,KAAKC,GAAG,CAACC,OAAOC,MAAM,CAACN,WAAWO,MAAM,EAAEF,OAAOC,MAAM,CAACL,QAAQM,MAAM,IAAI,EAAE;AAC9E,OAAO,MAAMC,cAAcC,YAAYC,iBAAiB,GAAGR,cAAc;AAMzE,OAAO,MAAMS,QAAQ,CACnBC,MACAC,QACA,EAAEC,UAAU,IAAI,EAAW,GAAG,CAAC,CAAC;IAEhC,MAAMC,aAAanB,UAAUgB;IAC7B,MAAMI,YAAYH,OAAOI,UAAU,GAAGT;IACtC,MAAMU,YAAYH,WAAWR,MAAM;IACnC,MAAMY,cAAchB,KAAKiB,IAAI,CAACF,YAAYF;IAE1C,MAAMK,SAAS,IAAIC,WAAWT;IAC9BQ,MAAM,GAAsB,GAAGH;IAC/BG,MAAM,GAAwB,GAAGF;IAEjCI,QAAQC,KAAK,CAACH,QAAQvB;IACtByB,QAAQE,MAAM,CAACJ,QAAQvB;IAEvB,IAAI;QACF,IACEyB,QAAQG,IAAI,CAACL,QAAQvB,cAAgCgB,aACrD,aACA;YACA,MAAM,IAAIa,MAAM;QAClB;QAEA,MAAMC,UAAU,IAAIC,WAAWhB,QAAQL;QAEvC,IAAK,IAAIsB,IAAI,GAAGA,IAAIX,aAAaW,IAAK;YACpC,MAAMC,QAAQD,IAAId;YAClB,MAAMgB,MAAM7B,KAAK8B,GAAG,CAACF,QAAQf,WAAWE;YACxC,MAAMgB,OAAOF,MAAMD;YAEnBH,QAAQO,GAAG,CAACpB,WAAWqB,QAAQ,CAACL,OAAOC,MAAM;YAE7CX,MAAM,GAAoB,GAAGS;YAC7BT,MAAM,GAAqB,GAAGU;YAC9BV,MAAM,GAAmB,GAAGa;YAE5BX,QAAQC,KAAK,CAACH,QAAQvB;YACtByB,QAAQE,MAAM,CAACJ,QAAQvB;YAEvB,IACEyB,QAAQG,IAAI,CAACL,QAAQvB,cAA8BgB,aACnD,aACA;gBACA,MAAM,IAAIa,MAAM,CAAC,wBAAwB,EAAEG,EAAE,CAAC,EAAEX,cAAc,GAAG;YACnE;QACF;IACF,SAAU;QACRI,QAAQC,KAAK,CAACH,QAAQvB;IACxB;AACF,EAAE;AAEF,OAAO,MAAMuC,OAAO,CAACxB,QACnB,EAAEC,UAAU,IAAI,EAAW,GAAG,CAAC,CAAC;IAEhC,MAAMO,SAAS,IAAIC,WAAWT;IAC9B,IACEU,QAAQG,IAAI,CAACL,QAAQvB,cAA4BgB,aAAa,aAC9D;QACA,MAAM,IAAIa,MAAM;IAClB;IACA,IAAIN,MAAM,CAACvB,UAAU,QAA0B;QAC7C,MAAM,IAAI6B,MAAM;IAClB;IAEA,MAAMT,YAAYG,MAAM,GAAsB;IAC9C,MAAMF,cAAcE,MAAM,GAAwB;IAClD,MAAMT,OAAO,IAAIiB,WAAWX;IAE5BK,QAAQC,KAAK,CAACH,QAAQvB;IACtByB,QAAQE,MAAM,CAACJ,QAAQvB;IAEvB,MAAM8B,UAAU,IAAIC,WAAWhB,QAAQL;IACvC,IAAK,IAAIsB,IAAI,GAAGA,IAAIX,aAAaW,IAAK;QACpC,IACEP,QAAQG,IAAI,CAACL,QAAQvB,cAA4BgB,aAAa,aAC9D;YACA,MAAM,IAAIa,MAAM,CAAC,iCAAiC,EAAEG,GAAG;QACzD;QAEA,IAAIT,MAAM,CAACvB,UAAU,QAAwB;YAC3C,MAAM,IAAI6B,MACR,CAAC,kCAAkC,EAAE5B,SAAS,CAACsB,MAAM,CAACvB,UAAU,CAAC,EAAE;QAEvE;QACA,MAAMwC,aAAajB,MAAM,GAAoB;QAC7C,IAAIS,MAAMQ,YAAY;YACpB,MAAM,IAAIX,MACR,CAAC,mCAAmC,EAAEW,WAAW,UAAU,EAAER,GAAG;QAEpE;QACA,MAAMS,SAASlB,MAAM,GAAqB;QAC1C,MAAMa,OAAOb,MAAM,GAAmB;QACtCT,KAAKuB,GAAG,CAACP,QAAQQ,QAAQ,CAAC,GAAGF,OAAOK;QACpChB,QAAQC,KAAK,CAACH,QAAQvB;QACtByB,QAAQE,MAAM,CAACJ,QAAQvB;IACzB;IACA,OAAOD,YAAYe;AACrB,EAAE"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "sabcom",
|
|
3
|
-
"version": "0.0.
|
|
4
|
-
"description": "",
|
|
3
|
+
"version": "0.0.3",
|
|
4
|
+
"description": "A TypeScript/Node.js library for inter-thread communication using SharedArrayBuffer with atomic operations and V8 serialization",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"types": "build/index.d.ts",
|
|
7
7
|
"main": "build/index.cjs",
|
|
@@ -14,7 +14,20 @@
|
|
|
14
14
|
"build",
|
|
15
15
|
"src/index.ts"
|
|
16
16
|
],
|
|
17
|
-
"
|
|
17
|
+
"repository": {
|
|
18
|
+
"type": "git",
|
|
19
|
+
"url": "git+https://github.com/3axap4eHko/sabcom.git"
|
|
20
|
+
},
|
|
21
|
+
"keywords": [
|
|
22
|
+
"SharedArrayBuffer",
|
|
23
|
+
"shared",
|
|
24
|
+
"atomic",
|
|
25
|
+
"buffer",
|
|
26
|
+
"thread",
|
|
27
|
+
"worker",
|
|
28
|
+
"communication"
|
|
29
|
+
],
|
|
30
|
+
"license": "MIT",
|
|
18
31
|
"author": {
|
|
19
32
|
"name": "Ivan Zakharchanka",
|
|
20
33
|
"email": "3axap4eHko@gmail.com",
|
package/src/index.ts
CHANGED
|
@@ -24,10 +24,14 @@ export const HEADER_VALUES =
|
|
|
24
24
|
Math.max(Object.values(Handshake).length, Object.values(Header).length) / 2;
|
|
25
25
|
export const HEADER_SIZE = Uint32Array.BYTES_PER_ELEMENT * HEADER_VALUES;
|
|
26
26
|
|
|
27
|
+
export interface Options {
|
|
28
|
+
timeout?: number;
|
|
29
|
+
}
|
|
30
|
+
|
|
27
31
|
export const write = (
|
|
28
32
|
data: unknown,
|
|
29
33
|
buffer: SharedArrayBuffer,
|
|
30
|
-
timeout = 5000
|
|
34
|
+
{ timeout = 5000 }: Options = {}
|
|
31
35
|
) => {
|
|
32
36
|
const serialized = serialize(data);
|
|
33
37
|
const chunkSize = buffer.byteLength - HEADER_SIZE;
|
|
@@ -77,7 +81,9 @@ export const write = (
|
|
|
77
81
|
}
|
|
78
82
|
};
|
|
79
83
|
|
|
80
|
-
export const read = (buffer: SharedArrayBuffer,
|
|
84
|
+
export const read = (buffer: SharedArrayBuffer,
|
|
85
|
+
{ timeout = 5000 }: Options = {}
|
|
86
|
+
): unknown => {
|
|
81
87
|
const header = new Int32Array(buffer);
|
|
82
88
|
if (
|
|
83
89
|
Atomics.wait(header, SEMAPHORE, Semaphore.READY, timeout) === "timed-out"
|