Object built-in object

Object Service

System Service Management Object

Inheritance

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<class>EventEmitter|new EventEmitter()|EventEmitter|defaultMaxListeners|on();addListener();prependListener();once();prependOnceListener();off();removeListener();removeAllListeners();setMaxListeners();getMaxListeners();listeners();listenerCount();eventNames();emit()] [<this>Service|new Service()|install();remove();start();stop();restart();isInstalled();isRunning()|name;onstop;onpause;oncontinue|run()] [object] <:- [EventEmitter] [EventEmitter] <:- [Service] EventEmitter new EventEmitter() EventEmitter defaultMaxListeners on() addListener() prependListener() once() prependOnceListener() off() removeListener() removeAllListeners() setMaxListeners() getMaxListeners() listeners() listenerCount() eventNames() emit() Service new Service() install() remove() start() stop() restart() isInstalled() isRunning() name onstop onpause oncontinue run() object toString() toJSON()

Constructor

Service

System Service Management Object Constructor

1 2 3
new Service(String name, Function worker, Object event = {});

Call parameters:

  • name: String, service name
  • worker: Function, service operation function
  • event: Object, service event handling

Static function

install

Install service to the system

1 2 3 4
static Service.install(String name, String cmd, String displayName = "", String description = "");

Call parameters:

  • name: String, service name
  • cmd: String, service command line
  • displayName: String, service display name
  • description: String, service description information

remove

Uninstall the service from the system

1
static Service.remove(String name);

Call parameters:

  • name: String, service name

start

Start service

1
static Service.start(String name);

Call parameters:

  • name: String, service name

stop

Out of service

1
static Service.stop(String name);

Call parameters:

  • name: String, service name

restart

Restart service

1
static Service.restart(String name);

Call parameters:

  • name: String, service name

isInstalled

Check whether the service is installed

1
static Boolean Service.isInstalled(String name);

Call parameters:

  • name: String, service name

Return result:

  • Boolean, Service installation returns True

isRunning

Check if the service is running

1
static Boolean Service.isRunning(String name);

Call parameters:

  • name: String, service name

Return result:

  • Boolean, The service operation returns True

Static properties

defaultMaxListeners

Integer, the default global maximum number of listeners

1
static Integer Service.defaultMaxListeners;

Member attributes

name

String, query and set the service name

1
String Service.name;

onstop

Function, query and bind service stop event, equivalent to on("stop", func);

1
Function Service.onstop;

onpause

Function, query and bind service pause events, equivalent to on("pause", func);

1
Function Service.onpause;

oncontinue

Function, query and bind service recovery events, equivalent to on("continue", func);

1
Function Service.oncontinue;

Member function

run

Start running the service entity

1
Service.run() async;

on

Bind an event handler to the object

1 2
Object Service.on(String ev, Function func);

Call parameters:

  • ev: String, specify the name of the event
  • func: Function, specify event processing function

Return result:

  • Object, Return the event object itself, which is convenient for chain call

Bind an event handler to the object

1
Object Service.on(Object map);

Call parameters:

  • map: Object, specify the event mapping relationship, the object property name will be used as the event name, and the property value will be used as the event processing function

Return result:

  • Object, Return the event object itself, which is convenient for chain call

addListener

Bind an event handler to the object

1 2
Object Service.addListener(String ev, Function func);

Call parameters:

  • ev: String, specify the name of the event
  • func: Function, specify event processing function

Return result:

  • Object, Return the event object itself, which is convenient for chain call

Bind an event handler to the object

1
Object Service.addListener(Object map);

Call parameters:

  • map: Object, specify the event mapping relationship, the object property name will be used as the event name, and the property value will be used as the event processing function

Return result:

  • Object, Return the event object itself, which is convenient for chain call

prependListener

Bind an event handler to the start of the object

1 2
Object Service.prependListener(String ev, Function func);

Call parameters:

  • ev: String, specify the name of the event
  • func: Function, specify event processing function

Return result:

  • Object, Return the event object itself, which is convenient for chain call

Bind an event handler to the start of the object

1
Object Service.prependListener(Object map);

Call parameters:

  • map: Object, specify the event mapping relationship, the object property name will be used as the event name, and the property value will be used as the event processing function

Return result:

  • Object, Return the event object itself, which is convenient for chain call

once

Bind a one-time event processing function to the object, the one-time processing function will only be triggered once

1 2
Object Service.once(String ev, Function func);

Call parameters:

  • ev: String, specify the name of the event
  • func: Function, specify event processing function

Return result:

  • Object, Return the event object itself, which is convenient for chain call

Bind a one-time event processing function to the object, the one-time processing function will only be triggered once

1
Object Service.once(Object map);

Call parameters:

  • map: Object, specify the event mapping relationship, the object property name will be used as the event name, and the property value will be used as the event processing function

Return result:

  • Object, Return the event object itself, which is convenient for chain call

prependOnceListener

Bind an event handler to the start of the object

1 2
Object Service.prependOnceListener(String ev, Function func);

Call parameters:

  • ev: String, specify the name of the event
  • func: Function, specify event processing function

Return result:

  • Object, Return the event object itself, which is convenient for chain call

Bind an event handler to the start of the object

1
Object Service.prependOnceListener(Object map);

Call parameters:

  • map: Object, specify the event mapping relationship, the object property name will be used as the event name, and the property value will be used as the event processing function

Return result:

  • Object, Return the event object itself, which is convenient for chain call

off

Cancel the specified function from the object processing queue

1 2
Object Service.off(String ev, Function func);

Call parameters:

  • ev: String, specify the name of the event
  • func: Function, specify event processing function

Return result:

  • Object, Return the event object itself, which is convenient for chain call

Cancel all functions in the object processing queue

1
Object Service.off(String ev);

Call parameters:

  • ev: String, specify the name of the event

Return result:

  • Object, Return the event object itself, which is convenient for chain call

Cancel the specified function from the object processing queue

1
Object Service.off(Object map);

Call parameters:

  • map: Object, specify the event mapping relationship, the object property name is used as the event name, and the property value is used as the event processing function

Return result:

  • Object, Return the event object itself, which is convenient for chain call

removeListener

Cancel the specified function from the object processing queue

1 2
Object Service.removeListener(String ev, Function func);

Call parameters:

  • ev: String, specify the name of the event
  • func: Function, specify event processing function

Return result:

  • Object, Return the event object itself, which is convenient for chain call

Cancel all functions in the object processing queue

1
Object Service.removeListener(String ev);

Call parameters:

  • ev: String, specify the name of the event

Return result:

  • Object, Return the event object itself, which is convenient for chain call

Cancel the specified function from the object processing queue

1
Object Service.removeListener(Object map);

Call parameters:

  • map: Object, specify the event mapping relationship, the object property name is used as the event name, and the property value is used as the event processing function

Return result:

  • Object, Return the event object itself, which is convenient for chain call

removeAllListeners

Cancel all the listeners of all events from the object processing queue. If an event is specified, remove all the listeners of the specified event.

1
Object Service.removeAllListeners(String ev);

Call parameters:

  • ev: String, specify the name of the event

Return result:

  • Object, Return the event object itself, which is convenient for chain call

Cancel all the listeners of all events from the object processing queue. If an event is specified, remove all the listeners of the specified event.

1
Object Service.removeAllListeners(Array evs = []);

Call parameters:

  • evs: Array, specify the name of the event

Return result:

  • Object, Return the event object itself, which is convenient for chain call

setMaxListeners

The default limit of the number of listeners, only for compatibility

1
Service.setMaxListeners(Integer n);

Call parameters:

  • n: Integer, specify the number of events

getMaxListeners

Get the default limit of the number of listeners, only for compatibility

1
Integer Service.getMaxListeners();

Return result:

  • Integer, Return to the default limit number

listeners

Array of listeners for the specified event of the query object

1
Array Service.listeners(String ev);

Call parameters:

  • ev: String, specify the name of the event

Return result:

  • Array, Returns an array of listeners for the specified event

listenerCount

The number of listeners for the specified event of the query object

1
Integer Service.listenerCount(String ev);

Call parameters:

  • ev: String, specify the name of the event

Return result:

  • Integer, Returns the number of listeners for the specified event

The number of listeners for the specified event of the query object

1 2
Integer Service.listenerCount(Value o, String ev);

Call parameters:

  • o: Value, specify the object of the query
  • ev: String, specify the name of the event

Return result:

  • Integer, Returns the number of listeners for the specified event

eventNames

Query the event name of the listener

1
Array Service.eventNames();

Return result:

  • Array, Returns an array of event names

emit

Trigger an event actively

1 2
Boolean Service.emit(String ev, ...args);

Call parameters:

  • ev: String, event name
  • args: ..., event parameters, which will be passed to the event handler

Return result:

  • Boolean, Return to the event trigger state, return true if there is a response event, otherwise return false

toString

Returns the string representation of the object, generally returns "[Native Object]", the object can be re-implemented according to its own characteristics

1
String Service.toString();

Return result:

  • String, Returns the string representation of the object

toJSON

Returns the JSON format representation of the object, generally returns a collection of readable attributes defined by the object

1
Value Service.toJSON(String key = "");

Call parameters:

  • key: String, unused

Return result:

  • Value, Returns a value containing JSON serializable