import DistributedMetrics from 'devapt-core-common/js/base/distributed_metrics.js'

public class | source

DistributedMetrics

DistributedMessage → DistributedMetrics

DistributedMetrics class for distributed communication.

Constructor Summary

Public Constructor
public	constructor(arg_sender_name: string \| object, arg_target_name: string, arg_type: string, arg_values: array, arg_channel: string, arg_buses_path: array): nothing Create a DistributedMetrics instance.

Public Members
public	is_distributed_metrics: boolean Class type flag.

Public Methods
public	check_msg_format(): boolean Check message format.
public	get_metrics_type(): string Get metric type.
public	get_metrics_values(): array Get metrics values.

From class DistributedMessage
public	is_distributed_message: boolean Class type flag.
private	_buses_path: array Message buses path.
private	_channel: string Message channel name.
private	_payload: object Message payload object.
private	_sender: string Message sender name.
private	_target: string Message target name.
public	add_buses_step(arg_bus_name: string): nothing Add a step to message buses path.
public	check_msg_format(): boolean Check message format.
public	get_channel(): string Get bus channel name.
public	get_payload(): object Get message sender.
public	get_sender(): string Get message sender.
public	get_target(): string Get message sender.
public	has_buses_step(arg_bus_name: string): nothing Test if message has a step into buses path.
public	set_channel(arg_channel: string): nothing Set bus channel name.

Create a DistributedMetrics instance.

Name	Type	Attribute	Description
arg_sender_name	string \| object		sender name or message plain object (without other args).
arg_target_name	string		recipient name.
arg_type	string		metrics type string.
arg_values	array		metrics values array.
arg_channel	string		channel name.
arg_buses_path	array		message buses path (optional default []).

nothing

Class type flag.

Check message format.

true:good format, false:bad format.

Get metric type.

metric type.

Get metrics values.

array

metrics values array.