@daneren2005/shared-memory-objects 0.0.2 → 0.0.3

package/README.md

@@ -8,6 +8,50 @@ Each allocated memory location can be stored as an int pointer.  You can use `ge
 
 When passing memory to another thread you can either pass a pointer or a serialized version of the buffer position/byte offset in order to re-create the object in the other thread.
 
+## Getting Started
+`npm install @daneren2005/shared-memory-objects`
+
+Example to update blocks of memory from a thread.
+```
+let heap = new MemoryHeap();
+let memory = heap.allocUI32(4);
+
+// Pass memory to another thread
+thread.postMessage({
+	heap: heap.getSharedMemory(),
+	memory: memory.getSharedMemory()
+});
+
+// From worker thread re-construct memory and change it
+self.onmessage = (e) => {
+	let heap = new MemoryHeap(e.data.heap);
+	let memory = new AllocatedMemory(heap, e.data.memory);
+	memory.data[2] = 5;
+};
+```
+
+// Example to work with data structures from a thread.  When constructing a new structure you just pass the heap.  When re-creating a structure from an already initialized memory location pass the heap and the shared memory location for it.
+```
+let heap = new MemoryHeap();
+let list = new SharedList(heap);
+
+// Pass memory to another thread
+thread.postMessage({
+	heap: heap.getSharedMemory(),
+	list: list.getSharedMemory()
+});
+
+// From worker thread re-construct memory and change it
+self.onmessage = (e) => {
+	let heap = new MemoryHeap(e.data.heap);
+	let list = new SharedList(heap, e.data.list);
+
+	list.push(5);
+};
+```
+let mainList = new SharedList(memory);
+let secondList = new SharedList(memory, mainList.getSharedMemory());
+
 ## Data Structures
 - SharedList
 - SharedVector

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@daneren2005/shared-memory-objects",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "author": "daneren2005@gmail.com",
   "description": "Creating objects with a SharedArrayBuffer",
   "homepage": "https://github.com/daneren2005/shared-memory-objects#readme",

package/src/main.ts

@@ -3,12 +3,13 @@ import MemoryBuffer from './memory-buffer';
 import MemoryHeap, { type MemoryHeapMemory } from './memory-heap';
 
 import SharedList, { type SharedListMemory } from './shared-list';
-import SharedMap from './shared-map';
+import SharedMap, { type SharedMapMemory } from './shared-map';
 import SharedPointerList from './shared-pointer-list';
 import SharedString from './shared-string';
-import SharedVector from './shared-vector';
+import SharedVector, { type SharedVectorMemory } from './shared-vector';
 
-import type { TypedArrayConstructor } from './interfaces/typed-array-constructor';
+export * from './interfaces/typed-array';
+export * from './interfaces/typed-array-constructor';
 
 export * from './utils/16-from-32-array';
 export * from './utils/16-from-64-array';
@@ -27,9 +28,9 @@ export {
 	SharedList,
 	type SharedListMemory,
 	SharedMap,
+	type SharedMapMemory,
 	SharedPointerList,
 	SharedString,
 	SharedVector,
-
-	type TypedArrayConstructor
+	type SharedVectorMemory
 };

package/src/shared-list.ts

@@ -67,6 +67,7 @@ export default class SharedList<T extends Uint32Array | Int32Array | Float32Arra
 		} else {
 			if(config && config.initWithBlock) {
 				this.firstBlock = new AllocatedMemory(memory, config.initWithBlock);
+				console.log(`init block at ${this.firstBlock.data.byteOffset}`);
 			} else {
 				this.firstBlock = memory.allocUI32(FIRST_BLOCK_RECORD_KEEPING_COUNT);
 			}
@@ -124,6 +125,7 @@ export default class SharedList<T extends Uint32Array | Int32Array | Float32Arra
 		} else {
 			// First item - store on first block
 			storeRawPointer(this.firstBlock.data, 0, newBlockPointer);
+			console.log(`insert first block ${newBlockPointer} at ${this.firstBlock.data.byteOffset}`);
 		}
 		
 		// Always update new last buffer position and length
@@ -170,6 +172,7 @@ export default class SharedList<T extends Uint32Array | Int32Array | Float32Arra
 	*[Symbol.iterator]() {
 		let currentIndex = 0;
 		let { bufferPosition: nextBlockPosition, bufferByteOffset: nextBlockByteOffset } = loadPointer(this.firstBlock.data, 0);
+		console.log(`checking first block: ${nextBlockByteOffset} at ${this.firstBlock.data.byteOffset}`);
 		let lastBlockData = this.firstBlock.data;
 		let lastBlockPosition = 0;
 		let lastBlockByteOffset = 0;