ciorent 0.3.8 → 0.4.0

package/README.md

@@ -118,7 +118,7 @@ Pubsub allows broadcasting messages to topics that can be recieved by subscriber
 import * as topic from 'ciorent/topic';
 import * as co from 'ciorent';
 
-const numbers = topic.init();
+const numbers = topic.init<number>();
 
 // Spawn 3 tasks that subscribe to the topic
 co.spawn(3, async (id) => {
@@ -141,43 +141,14 @@ for (let i = 0; i < 3; i++) {
 topic.flush(numbers);
 ```
 
-### Semaphore
-Semaphore is a concurrency primitive used to control access to a common resource by multiple processes.
-
-```ts
-import * as semaphore from 'ciorent/semaphore';
-import * as co from 'ciorent';
-
-// Only allow 2 task to run concurrently
-const sem = semaphore.init(2);
-
-const task = async (id: number) => {
-  // Acquire the semaphore or wait for the semaphore to be available
-  await semaphore.acquire(sem);
-
-  console.log('Task', id, 'started');
-
-  // Let the main thread schedules other tasks
-  for (let i = 1; i <= 5; i++) await co.nextTick;
-
-  console.log('Task', id, 'end');
-
-  // Release the semaphore
-  semaphore.release(sem);
-}
-
-// Try to run 5 tasks concurrently
-co.spawn(5, task);
-```
-
-### Pubsub
-Pubsub allows broadcasting messages to topics that can be recieved by subscribers.
+### Stream
+Send and recieve data asynchronously through streams.
 
 ```ts
 import * as stream from 'ciorent/stream';
 import * as co from 'ciorent';
 
-const numbers = stream.init();
+const numbers = stream.init<number>();
 
 // Spawn 3 tasks that read from the stream
 co.spawn(3, async (id) => {
@@ -198,33 +169,33 @@ for (let i = 0; i < 3; i++) {
 stream.flush(numbers);
 ```
 
-### Defer
-Wait for a value to be resolved.
+### Semaphore
+Semaphore is a concurrency primitive used to control access to a common resource by multiple processes.
 
 ```ts
-import * as defer from 'ciorent/defer';
+import * as semaphore from 'ciorent/semaphore';
+import * as co from 'ciorent';
 
-const logTime = (label: string) => console.log(`${label}: ${Math.floor(performance.now())}ms`);
+// Only allow 2 task to run concurrently
+const sem = semaphore.init(2);
 
-const deferredUrl = defer.init<string>();
+const task = async (id: number) => {
+  // Acquire the semaphore or wait for the semaphore to be available
+  await semaphore.acquire(sem);
 
-const task = async () => {
-  // Blocks until the defer is resolved
-  const url = await defer.wait(deferredUrl);
+  console.log('Task', id, 'started');
 
-  logTime('Start fetching');
-  await fetch(url).catch(() => {});
-  logTime('Done fetching');
-}
+  // Let the main thread schedules other tasks
+  for (let i = 1; i <= 5; i++) await co.nextTick;
 
-const prepare = () => {
-  // This always run first as task is waiting
-  logTime('Run before fetch');
-  defer.resolve(deferredUrl, 'http://localhost:3000');
+  console.log('Task', id, 'end');
+
+  // Release the semaphore
+  semaphore.release(sem);
 }
 
-task();
-prepare();
+// Try to run 5 tasks concurrently
+co.spawn(5, task);
 ```
 
 ### Fibers

package/fiber.d.ts

@@ -5,21 +5,9 @@
  * Describe a fiber process
  */
 export type Process<TReturn = unknown> = [
-    /**
-     * The waiting promise
-     */
     proc: Promise<TReturn | undefined>,
-    /**
-     * Fiber status
-     */
     status: 0 | 1 | 2 | 3,
-    /**
-     * Callback to resume the fiber
-     */
     resume: null | ((state: 1 | 3) => void),
-    /**
-     * Bounded fibers
-     */
     children: Process[]
 ];
 /**

package/index.js

@@ -1 +1 @@
-export let nextTick=Promise.resolve();export let sleep=globalThis.Bun?.sleep??globalThis.process?.getBuiltinModule?.("timers/promises").setTimeout??((ms)=>new Promise((res)=>{setTimeout(res,ms)}));let sharedBuf=new Int32Array(new SharedArrayBuffer(4));export let sleepSync=globalThis.Bun?.sleepSync??((ms)=>{Atomics.wait(sharedBuf,0,0,ms)});export let sequential=async(n,task,...args)=>{for(let i=0;i<n;i++)await task(...args,i)};export let spawn=(n,task,...args)=>{let arr=new Array(n);for(let i=0;i<n;i++)arr[i]=task(...args,i);return arr};export let debounce=(f,ms)=>{let id;return(...a)=>{clearTimeout(id);id=setTimeout(f,ms,...a)}};export let throttle=(ms,limit)=>{let head=[null];let tail=head;let promiseCb=(res)=>{head=head[0]=[null,res]};let cur=limit;let scheduled=false;let unlock=()=>{cur=limit;if(tail===head){scheduled=false;return}do{cur--;(tail=tail[0])[1]()}while(cur>0&&tail!==head);setTimeout(unlock,ms)};return()=>{if(cur===0)return new Promise(promiseCb);if(!scheduled){scheduled=true;setTimeout(unlock,ms)}cur--;return nextTick}};
+export let nextTick=Promise.resolve();export let sleep=globalThis.Bun?.sleep??globalThis.process?.getBuiltinModule?.("timers/promises").setTimeout??((ms)=>new Promise((res)=>{setTimeout(res,ms)}));let sharedBuf=new Int32Array(new SharedArrayBuffer(4));export let sleepSync=globalThis.Bun?.sleepSync??((ms)=>{Atomics.wait(sharedBuf,0,0,ms)});export let sequential=async(n,task,...args)=>{for(let i=0;i<n;i++)await task(...args,i)};export let spawn=(n,task,...args)=>{let arr=new Array(n);for(let i=0;i<n;i++)arr[i]=task(...args,i);return arr};export let debounce=(f,ms)=>{let id;return(...a)=>{clearTimeout(id);id=setTimeout(f,ms,...a)}};export let throttle=(ms,limit)=>{let head=[null];let tail=head;let promiseCb=(res)=>{head=head[0]=[null,res]};let cur=limit;let scheduled=false;let unlock=()=>{cur=limit;if(tail===head){scheduled=false;return}do{cur--;(tail=tail[0])[1]()}while(cur>0&&tail!==head);setTimeout(unlock,ms)};return async()=>{if(cur===0)return new Promise(promiseCb);if(!scheduled){scheduled=true;setTimeout(unlock,ms)}cur--}};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ciorent",
-  "version": "0.3.8",
+  "version": "0.4.0",
   "description": "A lightweight, low-overhead concurrency library",
   "homepage": "https://ciorent.netlify.app",
   "repository": {
@@ -18,15 +18,11 @@
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {
-    "./queue": "./queue.js",
-    "./sliding-queue": "./sliding-queue.js",
-    "./dropping-queue": "./dropping-queue.js",
+    "./fiber": "./fiber.js",
+    "./queue": "./queue.d.ts",
     "./semaphore": "./semaphore.js",
-    "./lock": "./lock.js",
-    "./defer": "./defer.js",
-    ".": "./index.js",
     "./stream": "./stream.js",
     "./topic": "./topic.js",
-    "./fiber": "./fiber.js"
+    ".": "./index.js"
   }
 }

package/queue.d.ts

@@ -4,30 +4,21 @@
 /**
  * Describe a fixed-sized queue
  */
-export type Fixed<T extends {} = {}> = [
-    /**
-     * Pre-allocated queue
-     */
+export type FixedQueue<T extends {} = {}> = [
     buffer: (T | undefined | null)[],
-    /**
-     * Queue capacity
-     */
     capacity: number,
-    /**
-     * Head pointer
-     */
     head: number,
-    /**
-     * Tail pointer
-     */
     tail: number
 ];
 /**
  * Describe a queue node (singly linked list node)
  */
-export type Node<T> = [next: Node<T> | null, value: T];
+export type QueueNode<T> = [next: QueueNode<T> | null, value: T];
 /**
- * Create a fixed queue
- * @param n - The queue size
+ * Describe an unbounded queue
  */
-export declare const fixed: <T extends {} = {}>(n: number) => Fixed<T>;
+export type UnboundedQueue<T> = [head: QueueNode<T>, tail: QueueNode<T>];
+/**
+ * Cached promise callback
+ */
+export type PromiseFn<T = any> = (res: (value?: T) => void) => void;

package/semaphore.d.ts

@@ -1,16 +1,15 @@
 /**
  * @module Semaphores
  */
-import { type Lock } from './lock.js';
+import type { PromiseFn, UnboundedQueue } from './queue.js';
 /**
  * Describe a semaphore
  */
-export type Semaphore = Lock<void, [
-    /**
-     * Current remaining process allowed
-     */
+export type Semaphore = [
+    ...UnboundedQueue<() => void>,
+    callback: PromiseFn<void>,
     remain: number
-]>;
+];
 /**
  * Create a semaphore that allows n accesses
  */

package/semaphore.js

@@ -1 +1 @@
-import{nextTick as resolvedPromise}from"./index.js";import{release as lockRelease}from"./lock.js";export let init=(n)=>{let root=[null];let sem=[root,root,(res)=>{sem[0]=sem[0][0]=[null,res]},n];return sem};export let acquire=(s)=>{s[3]--;return s[3]>=0?resolvedPromise:new Promise(s[2])};export let release=(s)=>{if(s[3]<0)lockRelease(s);s[3]++};export let bind=(f,s)=>async(...a)=>{s[3]--;if(s[3]<0)await new Promise(s[2]);try{return await f(...a)}finally{if(s[3]<0)release(s);s[3]++}};
+export let init=(n)=>{let root=[null];let sem=[root,root,(res)=>{sem[0]=sem[0][0]=[null,res]},n];return sem};export let acquire=async(s)=>{s[3]--;if(s[3]<0)return new Promise(s[2])};export let release=(s)=>{if(s[3]<0)(s[1]=s[1][0])[1]();s[3]++};export let bind=(f,s)=>async(...a)=>{s[3]--;if(s[3]<0)await new Promise(s[2]);try{return await f(...a)}finally{if(s[3]<0)(s[1]=s[1][0])[1]();s[3]++}};

package/stream.d.ts

@@ -1,28 +1,14 @@
 /**
  * @module Streams
  */
-import type { Node as QueueNode } from './queue.js';
-import type { AcquireCallback } from './lock.js';
+import type { PromiseFn, UnboundedQueue } from './queue.js';
 /**
  * Describe a stream
  */
 export type Stream<T extends {} = {}> = [
-    /**
-     * Queue head
-     */
-    head: QueueNode<T | ((val?: T) => void)>,
-    /**
-     * Queue tail
-     */
-    tail: QueueNode<T | ((val?: T) => void)>,
-    /**
-     * Whether the queue is containing items
-     */
-    queueing: boolean,
-    /**
-     * Cached callback
-     */
-    callback: AcquireCallback<T>
+    ...UnboundedQueue<T | ((val?: T) => void)>,
+    callback: PromiseFn<T>,
+    queueing: boolean
 ];
 /**
  * Create a stream

package/stream.js

@@ -1 +1 @@
-export let init=()=>{let queue=[null];let s=[queue,queue,false,(res)=>{s[0]=s[0][0]=[null,res]}];return s};export let write=(s,v)=>{if(!s[2]){if(s[1][0]!==null){(s[1]=s[1][0])[1](v);return}s[2]=true}s[0]=s[0][0]=[null,v]};export let read=(s)=>{if(s[2]){s[1]=s[1][0];if(s[1][0]===null)s[2]=false;return Promise.resolve(s[1][1])}return new Promise(s[3])};export let flush=(s)=>{if(!s[2])while(s[1][0]!==null)(s[1]=s[1][0])[1]()};
+export let init=()=>{let queue=[null];let s=[queue,queue,(res)=>{s[0]=s[0][0]=[null,res]},false];return s};export let write=(s,v)=>{if(!s[3]){if(s[1][0]!==null){(s[1]=s[1][0])[1](v);return}s[3]=true}s[0]=s[0][0]=[null,v]};export let read=async(s)=>{if(s[3]){s[1]=s[1][0];if(s[1][0]===null)s[3]=false;return s[1][1]}return new Promise(s[2])};export let flush=(s)=>{if(!s[3])while(s[1][0]!==null)(s[1]=s[1][0])[1]()};

package/topic.d.ts

@@ -1,14 +1,13 @@
 /**
  * @module Pubsub
  */
-import type { AcquireCallback } from "./lock.js";
-import type { Node as QueueNode } from "./queue.js";
+import type { PromiseFn, QueueNode } from './queue.js';
 /**
  * Describe a topic
  */
 export type Topic<T extends {} = {}> = [
     head: QueueNode<T>,
-    callback: AcquireCallback<void>,
+    callback: PromiseFn<void>,
     resolve: (() => void) | null,
     pending: Promise<void> | null
 ];
@@ -41,6 +40,6 @@ export declare const flush: (t: Topic) => void;
 export declare const subscribe: <T extends {}>(t: Topic<T>) => Subscriber<T>;
 /**
  * Wait for messages from the topic
- * @param t
+ * @param s
  */
 export declare const dispatch: <T extends {}>(s: Subscriber<T>) => Promise<T | undefined>;

package/defer.d.ts

@@ -1,22 +0,0 @@
-/**
- * @module Deferred values
- */
-/**
- * Describe a defer
- */
-export type Defer<T = any> = [
-    wait: Promise<T>,
-    open: (value: T | PromiseLike<T>) => void
-];
-/**
- * Create a latch
- */
-export declare const init: <T>() => Defer<T>;
-/**
- * Wait until a deferred is resolved
- */
-export declare const wait: <T>(d: Defer<T>) => Promise<T>;
-/**
- * Resolve the defer
- */
-export declare const resolve: (<T extends {}>(d: Defer<T>, p: T | PromiseLike<T>) => void) & ((d: Defer<void>) => void);

package/defer.js

@@ -1 +0,0 @@
-export let init=()=>{let r;return[new Promise((res)=>{r=res}),r]};export let wait=(d)=>d[0];export let resolve=(d,p)=>{d[1](p)};

package/dropping-queue.d.ts

@@ -1,12 +0,0 @@
-/**
- * @module Dropping queues
- */
-import type { Fixed } from './queue.js';
-export { fixed as init } from './queue.js';
-export { pop } from './sliding-queue.js';
-/**
- * Push an item to a dropping queue
- * @param q - The queue to push to
- * @param item
- */
-export declare const push: <T extends {}>(q: Fixed<T>, item: T) => boolean;

package/dropping-queue.js

@@ -1 +0,0 @@
-export{fixed as init}from"./queue.js";export{pop}from"./sliding-queue.js";export let push=(q,item)=>{if(q[0][(q[2]+1)%q[1]]!=null)return false;q[0][q[2]=(q[2]+1)%q[1]]=item;return true};

package/lock.d.ts

@@ -1,33 +0,0 @@
-/**
- * @module Lock utilities
- */
-import type { Node as QueueNode } from './queue.js';
-/**
- * Describe a lock
- */
-export type Lock<T = any> = [
-    /**
-     * The head of the Promise resolve queue
-     */
-    head: QueueNode<(value?: T) => void>,
-    /**
-     * The tail of the Promise resolve queue
-     */
-    tail: QueueNode<(value?: T) => void>
-];
-/**
- * Release an item
- * @param lock
- * @param value
- */
-export declare const release: <T>(lock: Lock<T>, value?: T) => void;
-/**
- * Return true if all items are released
- * @param lock
- */
-export declare const released: (lock: Lock) => boolean;
-/**
- * Release all items of a lock
- * @param lock
- */
-export declare const flush: (lock: Lock) => void;

package/lock.js

@@ -1 +0,0 @@
-export let release=(lock,value)=>{(lock[1]=lock[1][0])[1](value)};export let released=(lock)=>lock[1][0]===null;export let flush=(lock)=>{while(lock[1][0]!==null)(lock[1]=lock[1][0])[1]()};

package/queue.js

@@ -1 +0,0 @@
-export let fixed=(n)=>[new Array(n),n,-1,-1];

package/sliding-queue.d.ts

@@ -1,16 +0,0 @@
-/**
- * @module Sliding queues
- */
-import type { Fixed } from './queue.js';
-export { fixed as init } from './queue.js';
-/**
- * Push an item to a sliding queue
- * @param q - The queue to push to
- * @param item
- */
-export declare const push: <T extends {}>(q: Fixed<T>, item: T) => void;
-/**
- * Pop an item from the queue
- * @param q - The queue to pop from
- */
-export declare const pop: <T extends {}>(q: Fixed<T>) => T | undefined;

package/sliding-queue.js

@@ -1 +0,0 @@
-export{fixed as init}from"./queue.js";export let push=(q,item)=>{q[0][q[2]=(q[2]+1)%q[1]]=item};export let pop=(q)=>{let val=q[0][(q[3]+1)%q[1]];if(val!=null){q[0][q[3]=(q[3]+1)%q[1]]=null;return val}};