wv-local-service

Purpose

To provide a (localhost) service that works through wv-local-service-broker's LocalServiceBroker running in a separate process (or in some scenarios you may run the broker and a service it in the same process ).

Package Dependencies

• socket.io.

Brief Documentation

• From package ws-local-service-broker you can start a broker by calling LocalServiceBroker.start().
• Only one LocalServiceBroker.start() invokation could be made in a process lifetime.
• LocalServiceBroker cannot be hosted in a web page, while LocalService could be hosted in a web page the same exact way as in a process with two way communication supported.
• The hosting machine could run only one LocalServiceBroker at a time on port 47979.
• If a LocalServiceBroker.start() is invoked from one or more processes while there is an already running one, the newest one/ones keeps/keep standby and one of them compensates the running one in the case of the exit of the running one.
• Each service connects to and identifies itself to the service broker through invoking LocalService.contributeAs() from wv-local-service package. The serivce identity is provided through the first argument serviceName.
• LocalService.contributeAs() could be invoked only once in a process or a web page.
• If a new service contributed later using the same service name. It replaces the old one (by design).
• A process or a web page could host only one service.
• Remote procedure calls between processes are done by instantiating an Envelop's subclass and calling envelop.postAsync() method.
• Envelop is an abstract class, so you typically inherit it to provide its own schema of request and response.

How to use it

import { LocalService } from 'wv-local-service' LocalService.contributeAs(serviceName: string, onConnectionStatusChanged?:(isConnected: boolean)=>void);

Please find the readme.md of wv-localhost-service-broker package for more info on the broker side.