@tiga-ipc/mmap 0.2.0 → 0.3.0

package/README.md

@@ -21,7 +21,7 @@ Current package scope:
 
 - Windows only
 - File-backed mapping usage
-- `mappingDirectory` must be passed explicitly by the caller
+- `ipcDirectory` must be passed explicitly by the caller
 
 ## Usage
 
@@ -34,10 +34,10 @@ const {
 } = require('@tiga-ipc/mmap');
 
 async function main() {
-  const mappingDirectory = 'C:\\temp\\tiga-ipc';
+  const ipcDirectory = 'C:\\temp\\tiga-ipc';
   const server = startTigaServer({
-    baseName: 'sample',
-    mappingDirectory,
+    channelName: 'sample',
+    ipcDirectory,
     onInvoke(method, data) {
       if (method === 'echo') {
         return `reply:${data}`;
@@ -54,7 +54,7 @@ async function main() {
       'echo',
       'hello from node',
       {
-        mappingDirectory,
+        ipcDirectory,
         timeoutMs: 3000,
       },
     );
@@ -62,12 +62,12 @@ async function main() {
     console.log(reply);
 
     tigaWrite('sample.events', 'event payload', {
-      mappingDirectory,
+      ipcDirectory,
       mediaType: 'text/plain',
     });
 
     const result = tigaRead('sample.events', {
-      mappingDirectory,
+      ipcDirectory,
       lastId: 0,
     });
 
@@ -89,7 +89,7 @@ main().catch((error) => {
 
 - `name: string`
 - `message: Buffer | string`
-- `options?.mappingDirectory: string`
+- `options?.ipcDirectory: string`
 - `options?.mediaType?: string`
 
 Returns a short write result string from the native addon.
@@ -97,7 +97,7 @@ Returns a short write result string from the native addon.
 ### `tigaRead(name, options?)`
 
 - `name: string`
-- `options?.mappingDirectory: string`
+- `options?.ipcDirectory: string`
 - `options?.lastId?: number`
 
 Returns:
@@ -119,15 +119,15 @@ interface TigaReadResult {
 - `responseName: string`
 - `method: string`
 - `data: string`
-- `options?.mappingDirectory: string`
+- `options?.ipcDirectory: string`
 - `options?.timeoutMs?: number`
 
 Returns the response payload string.
 
 ### `startTigaServer(options)` / `createTigaServer(options)`
 
-- `options.baseName: string`
-- `options.mappingDirectory: string`
+- `options.channelName: string`
+- `options.ipcDirectory: string`
 - `options.discoveryIntervalMs?: number`
 - `options.waitTimeoutMs?: number`
 - `options.onInvoke(method, data, context): unknown | Promise<unknown>`
@@ -139,11 +139,11 @@ Returns a `TigaServer` instance. `startTigaServer(...)` starts it immediately. `
 
 ```ts
 interface TigaServerContext {
-  baseName: string;
+  channelName: string;
   clientId: string;
   requestName: string;
   responseName: string;
-  mappingDirectory: string;
+  ipcDirectory: string;
   requestId: string;
   entryId: number;
   mediaType?: string | null;
@@ -152,7 +152,7 @@ interface TigaServerContext {
 
 The server helper keeps transport concerns inside the package:
 
-- discovers per-client request channels under the configured `mappingDirectory`
+- discovers per-client request channels under the configured `ipcDirectory`
 - registers request listeners using the native notification mechanism
 - decodes invoke payloads and writes response payloads back to the matching response channel
 - surfaces business logic as a single `onInvoke(...)` callback

package/index.d.ts

@@ -14,19 +14,19 @@ export interface TigaEntry {
   mediaType?: string
 }
 export interface TigaChannelOptions {
-  mappingDirectory?: string
+  ipcDirectory?: string
 }
 export interface TigaWriteOptions {
   mediaType?: string
-  mappingDirectory?: string
+  ipcDirectory?: string
 }
 export interface TigaReadOptions {
   lastId?: number
-  mappingDirectory?: string
+  ipcDirectory?: string
 }
 export interface TigaInvokeOptions {
   timeoutMs?: number
-  mappingDirectory?: string
+  ipcDirectory?: string
 }
 export declare function tigaWrite(name: string, message: Buffer | string, options?: TigaWriteOptions | undefined | null): string
 export declare function tigaRead(name: string, options?: TigaReadOptions | undefined | null): TigaReadResult
@@ -38,17 +38,17 @@ export declare class TigaNotificationListener {
   get closed(): boolean
 }
 export interface TigaServerContext {
-  baseName: string
+  channelName: string
   clientId: string
   requestName: string
   responseName: string
-  mappingDirectory: string
+  ipcDirectory: string
   requestId: string
   entryId: number
   mediaType?: string | null
 }
 export interface TigaServerOptions extends TigaChannelOptions {
-  baseName: string
+  channelName: string
   discoveryIntervalMs?: number
   waitTimeoutMs?: number
   onInvoke(method: string, data: unknown, context: TigaServerContext): unknown | Promise<unknown>
@@ -56,8 +56,8 @@ export interface TigaServerOptions extends TigaChannelOptions {
 }
 export declare class TigaServer {
   constructor(options: TigaServerOptions)
-  readonly baseName: string
-  readonly mappingDirectory: string
+  readonly channelName: string
+  readonly ipcDirectory: string
   readonly closed: boolean
   readonly started: boolean
   start(): TigaServer

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tiga-ipc/mmap",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Windows memory-mapped IPC bindings for Tiga channels.",
   "main": "index.js",
   "types": "index.d.ts",

package/runtime/server.js

@@ -26,17 +26,17 @@ const ensureString = (value, label) => {
   return value.trim();
 };
 
-const getStatePath = (mappingDirectory, name) =>
-  path.join(mappingDirectory, `${FILE_PREFIX}${name}${STATE_SUFFIX}`);
+const getStatePath = (ipcDirectory, name) =>
+  path.join(ipcDirectory, `${FILE_PREFIX}${name}${STATE_SUFFIX}`);
 
-const hasSingleChannel = (baseName, mappingDirectory) =>
-  fs.existsSync(getStatePath(mappingDirectory, baseName));
+const hasSingleChannel = (channelName, ipcDirectory) =>
+  fs.existsSync(getStatePath(ipcDirectory, channelName));
 
-const listClientIds = (baseName, mappingDirectory) => {
+const listClientIds = (channelName, ipcDirectory) => {
   try {
-    const prefix = `${FILE_PREFIX}${baseName}.req.`;
+    const prefix = `${FILE_PREFIX}${channelName}.req.`;
     return fs
-      .readdirSync(mappingDirectory)
+      .readdirSync(ipcDirectory)
       .filter((fileName) => fileName.startsWith(prefix))
       .filter((fileName) => fileName.endsWith(STATE_SUFFIX))
       .map((fileName) =>
@@ -48,29 +48,26 @@ const listClientIds = (baseName, mappingDirectory) => {
   }
 };
 
-const toClientState = (clientId, baseName) =>
+const toClientState = (clientId, channelName) =>
   clientId === SINGLE_CLIENT_ID
     ? {
         key: SINGLE_CLIENT_ID,
         clientId,
-        requestName: baseName,
-        responseName: baseName,
+        requestName: channelName,
+        responseName: channelName,
       }
     : {
         key: clientId,
         clientId,
-        requestName: `${baseName}.req.${clientId}`,
-        responseName: `${baseName}.resp.${clientId}`,
+        requestName: `${channelName}.req.${clientId}`,
+        responseName: `${channelName}.resp.${clientId}`,
       };
 
 class TigaServer {
   constructor(options) {
     const resolved = options || {};
-    this.baseName = ensureString(resolved.baseName, 'baseName');
-    this.mappingDirectory = ensureString(
-      resolved.mappingDirectory,
-      'mappingDirectory',
-    );
+    this.channelName = ensureString(resolved.channelName, 'channelName');
+    this.ipcDirectory = ensureString(resolved.ipcDirectory, 'ipcDirectory');
     if (typeof resolved.onInvoke !== 'function') {
       throw new Error('onInvoke must be a function');
     }
@@ -98,23 +95,23 @@ class TigaServer {
       return this;
     }
 
-    fs.mkdirSync(this.mappingDirectory, { recursive: true });
+    fs.mkdirSync(this.ipcDirectory, { recursive: true });
     this.started = true;
     this.closed = false;
     this.discoveryTimer = setInterval(() => {
       this.discover().catch((error) => {
         this.reportError(error, {
           stage: 'discover',
-          baseName: this.baseName,
-          mappingDirectory: this.mappingDirectory,
+          channelName: this.channelName,
+          ipcDirectory: this.ipcDirectory,
         });
       });
     }, this.discoveryIntervalMs);
     this.discover().catch((error) => {
       this.reportError(error, {
         stage: 'discover',
-        baseName: this.baseName,
-        mappingDirectory: this.mappingDirectory,
+        channelName: this.channelName,
+        ipcDirectory: this.ipcDirectory,
       });
     });
 
@@ -143,18 +140,18 @@ class TigaServer {
       return;
     }
 
-    const nextClients = listClientIds(this.baseName, this.mappingDirectory);
+    const nextClients = listClientIds(this.channelName, this.ipcDirectory);
     nextClients.forEach((clientId) => {
       if (!this.clients.has(clientId)) {
-        this.registerClient(toClientState(clientId, this.baseName));
+        this.registerClient(toClientState(clientId, this.channelName));
       }
     });
 
     if (
       !this.clients.has(SINGLE_CLIENT_ID) &&
-      hasSingleChannel(this.baseName, this.mappingDirectory)
+      hasSingleChannel(this.channelName, this.ipcDirectory)
     ) {
-      this.registerClient(toClientState(SINGLE_CLIENT_ID, this.baseName));
+      this.registerClient(toClientState(SINGLE_CLIENT_ID, this.channelName));
     }
   }
 
@@ -184,7 +181,7 @@ class TigaServer {
       {
         workerData: {
           name: client.requestName,
-          mappingDirectory: this.mappingDirectory,
+          ipcDirectory: this.ipcDirectory,
           waitTimeoutMs: this.waitTimeoutMs,
         },
       },
@@ -211,8 +208,8 @@ class TigaServer {
           clientId: client.clientId,
           requestName: client.requestName,
           responseName: client.responseName,
-          baseName: this.baseName,
-          mappingDirectory: this.mappingDirectory,
+          channelName: this.channelName,
+          ipcDirectory: this.ipcDirectory,
         });
       }
     });
@@ -223,8 +220,8 @@ class TigaServer {
         clientId: client.clientId,
         requestName: client.requestName,
         responseName: client.responseName,
-        baseName: this.baseName,
-        mappingDirectory: this.mappingDirectory,
+        channelName: this.channelName,
+        ipcDirectory: this.ipcDirectory,
       });
     });
 
@@ -283,7 +280,7 @@ class TigaServer {
     try {
       result = binding.tigaRead(client.requestName, {
         lastId: client.lastId,
-        mappingDirectory: this.mappingDirectory,
+        ipcDirectory: this.ipcDirectory,
       });
     } catch (error) {
       this.reportError(error, {
@@ -291,8 +288,8 @@ class TigaServer {
         clientId: client.clientId,
         requestName: client.requestName,
         responseName: client.responseName,
-        baseName: this.baseName,
-        mappingDirectory: this.mappingDirectory,
+        channelName: this.channelName,
+        ipcDirectory: this.ipcDirectory,
       });
       return;
     }
@@ -322,11 +319,11 @@ class TigaServer {
     }
 
     const context = {
-      baseName: this.baseName,
+      channelName: this.channelName,
       clientId: client.clientId,
       requestName: client.requestName,
       responseName: client.responseName,
-      mappingDirectory: this.mappingDirectory,
+      ipcDirectory: this.ipcDirectory,
       requestId: invoke.id,
       entryId: entry.id,
       mediaType: entry.mediaType || null,
@@ -362,7 +359,7 @@ class TigaServer {
     try {
       binding.tigaWrite(client.responseName, payload, {
         mediaType: TIGA_MEDIA_TYPE_MSGPACK,
-        mappingDirectory: this.mappingDirectory,
+        ipcDirectory: this.ipcDirectory,
       });
     } catch (error) {
       this.reportError(error, {
@@ -370,8 +367,8 @@ class TigaServer {
         clientId: client.clientId,
         requestName: client.requestName,
         responseName: client.responseName,
-        baseName: this.baseName,
-        mappingDirectory: this.mappingDirectory,
+        channelName: this.channelName,
+        ipcDirectory: this.ipcDirectory,
       });
     }
   }

package/runtime/workers/notification-listener.js

@@ -40,7 +40,7 @@ parentPort.on('message', (message) => {
 
 try {
   listener = createTigaNotificationListener(workerData.name, {
-    mappingDirectory: workerData.mappingDirectory,
+    ipcDirectory: workerData.ipcDirectory,
   });
   post({ type: 'ready' });