From b69dbeb54f622b999cbc995b83c00ef740e438d5 Mon Sep 17 00:00:00 2001 From: Xavier RODRIGUEZ Date: Mon, 20 May 2024 11:54:36 +0200 Subject: [PATCH] update perf interface (#72) * update perf interface * remove old ping interface in platofrm --- .../mqtt-panduza/interfaces/perf.md | 41 +++++++++++++++++++ .../mqtt-panduza/interfaces/platform.md | 14 ------- 2 files changed, 41 insertions(+), 14 deletions(-) create mode 100644 content/docs/platform/specifications/mqtt-panduza/interfaces/perf.md diff --git a/content/docs/platform/specifications/mqtt-panduza/interfaces/perf.md b/content/docs/platform/specifications/mqtt-panduza/interfaces/perf.md new file mode 100644 index 0000000..c654232 --- /dev/null +++ b/content/docs/platform/specifications/mqtt-panduza/interfaces/perf.md @@ -0,0 +1,41 @@ +--- +title: "Perf" +weight: 300 +--- + +This document describes the specific attributes of Perf interfaces. + +Please refer to [API interface](/docs/mqtt/core.md) to get a generic description of the interface mechanism. + +The goal of the perf interface is to provide a way to test performance of the chain client/network/broker/platform. + +## Info + +```json +{ + "type": "perf", + "version": "0.0.0" +} +``` + +### Changelog + +#### Version 0.0 + +- Experimentations + +## Attributes + +| Attribute name | Retain Topic | +| :------------: | :----------: | +| ping | True | + +### `[PLATF_00000_00]` - Attribute 'ping' + +This attribute **must** have the following fields: + +| Field name | Description | Default | Type | Read-only | +| :--------- | :--------------------------------: | :-----: | :---: | :-------: | +| value | Contains the value set by the user | 0 | bytes | False | + +This attribute just set back the value. diff --git a/content/docs/platform/specifications/mqtt-panduza/interfaces/platform.md b/content/docs/platform/specifications/mqtt-panduza/interfaces/platform.md index dd55711..3784b33 100644 --- a/content/docs/platform/specifications/mqtt-panduza/interfaces/platform.md +++ b/content/docs/platform/specifications/mqtt-panduza/interfaces/platform.md @@ -99,18 +99,4 @@ Store structure } ``` -### `[PLATF_REQ_ITF_PLATFORM_0120_00]` - Attribute 'ping' - -The goal of the ping attribute is to provide a way to test performance of the chain client/network/broker/platform. - -This attribute **must** have the following fields: - -| Field name | Description | Default | Type | Read-only | -| :--------- | :----------------------------------------------------------: | :-----: | :-----: | :-------: | -| value | Contains the value set by the user | 0 | integer | False | - -When a client wants to start a perf test, he send 1 and wait for answer, then 2, then 3... the goal is to measure the number of iteration in 1 seconde. - - -