@eggjs/cluster 4.0.0-beta.20 → 4.0.0-beta.21

package/dist/master.d.ts

@@ -0,0 +1,90 @@
+import { ReadyEventEmitter } from 'get-ready';
+import { EggConsoleLogger as ConsoleLogger } from 'egg-logger';
+import { type ClusterOptions, type ParsedClusterOptions } from './utils/options.ts';
+import { WorkerManager } from './utils/worker_manager.ts';
+import { Messenger } from './utils/messenger.ts';
+import { AgentProcessUtils as ProcessAgentWorker } from './utils/mode/impl/process/agent.ts';
+import { AppProcessUtils as ProcessAppWorker } from './utils/mode/impl/process/app.ts';
+import { AgentThreadUtils as WorkerThreadsAgentWorker } from './utils/mode/impl/worker_threads/agent.ts';
+import { AppThreadUtils as WorkerThreadsAppWorker } from './utils/mode/impl/worker_threads/app.ts';
+export interface MasterOptions extends ParsedClusterOptions {
+    clusterPort?: number;
+    stickyWorkerPort?: number;
+}
+export declare class Master extends ReadyEventEmitter {
+    #private;
+    options: MasterOptions;
+    isStarted: boolean;
+    workerManager: WorkerManager;
+    messenger: Messenger;
+    isProduction: boolean;
+    agentWorkerIndex: number;
+    closed: boolean;
+    logger: ConsoleLogger;
+    agentWorker: ProcessAgentWorker | WorkerThreadsAgentWorker;
+    appWorker: ProcessAppWorker | WorkerThreadsAppWorker;
+    constructor(options?: ClusterOptions);
+    startByProcess(): void;
+    startByWorkerThreads(): void;
+    detectPorts(): Promise<void>;
+    log(msg: string, ...args: any[]): void;
+    startMasterSocketServer(cb: (err?: Error) => void): void;
+    stickyWorker(ip: string): import("./utils/mode/base/app.ts").BaseAppWorker<import("worker_threads").Worker | import("cluster").Worker>;
+    forkAgentWorker(): void;
+    forkAppWorkers(): void;
+    /**
+     * close agent worker, App Worker will closed by cluster
+     *
+     * https://www.exratione.com/2013/05/die-child-process-die/
+     * make sure Agent Worker exit before master exit
+     *
+     * @param {number} timeout - kill agent timeout
+     * @return {Promise} -
+     */
+    killAgentWorker(timeout: number): Promise<void>;
+    killAppWorkers(timeout: number): Promise<void>;
+    /**
+     * Agent Worker exit handler
+     * Will exit during startup, and refork during running.
+     */
+    onAgentExit(data: {
+        /** exit code */
+        code: number;
+        /** received signal */
+        signal: string;
+    }): void;
+    onAgentStart(): void;
+    /**
+     * App Worker exit handler
+     */
+    onAppExit(data: {
+        workerId: number;
+        code: number;
+        signal: string;
+    }): void;
+    /**
+     * after app worker
+     */
+    onAppStart(data: {
+        workerId: number;
+        address: ListeningAddress;
+    }): void;
+    /**
+     * master exit handler
+     */
+    onExit(code: number): void;
+    onSignal(signal: string): void;
+    /**
+     * reload workers, for develop purpose
+     */
+    onReload(): void;
+    close(): Promise<void>;
+    _doClose(): Promise<void>;
+}
+interface ListeningAddress {
+    port: number;
+    protocol: string;
+    address?: string;
+    addressType?: number;
+}
+export {};