You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
68 lines
1.8 KiB
68 lines
1.8 KiB
import RawIPC = require("node-ipc");
|
|
import { InternalService } from "../InternalService";
|
|
import { Microservice } from "../Microservice";
|
|
import { IPC, IpcMessageHandler } from "./schema";
|
|
|
|
/**
|
|
* An abstract IPC service containing common properties/methods among the server and client
|
|
*/
|
|
export default abstract class AbstractIpcService<M extends Microservice = Microservice> extends InternalService<M>
|
|
{
|
|
/**
|
|
* The IPC instance
|
|
*/
|
|
private __ipc: IPC|null = null;
|
|
|
|
// Implementation Requirements -----------------------------------------------------------------
|
|
|
|
/**
|
|
* The path to the socket file
|
|
*/
|
|
protected abstract get socketPath(): string;
|
|
|
|
/**
|
|
* Add a message handler for the service
|
|
*/
|
|
protected abstract addMessageHandler(method: string, handle: IpcMessageHandler): void;
|
|
|
|
/**
|
|
* Boot the IPC service after configuration is complete
|
|
*/
|
|
protected abstract bootIpc(ipc: IPC): Promise<void>;
|
|
|
|
/**
|
|
* Shutdown the IPC service before it is destroyed
|
|
*/
|
|
protected abstract shutdownIpc(ipc: IPC|null): Promise<void>;
|
|
|
|
// Service Management --------------------------------------------------------------------------
|
|
|
|
/**
|
|
* Boot the IPC service
|
|
*/
|
|
public async boot() {
|
|
// Create the IPC socket
|
|
this.__ipc = new RawIPC.IPC();
|
|
this.__ipc.config.id = this.name;
|
|
this.__ipc.config.retry = 1500;
|
|
this.__ipc.config.silent = true;
|
|
await this.bootIpc(this.__ipc);
|
|
}
|
|
|
|
/**
|
|
* Shutdown the IPC service
|
|
*/
|
|
public async shutdown() {
|
|
await this.shutdownIpc(this.__ipc);
|
|
this.__ipc = null;
|
|
}
|
|
|
|
// Accessors -----------------------------------------------------------------------------------
|
|
|
|
/**
|
|
* Get the raw IPC instance
|
|
*/
|
|
protected get rawIpcInstance(): IPC|null {
|
|
return this.__ipc;
|
|
}
|
|
}
|