You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/features/features.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ Basic c++ knowledge is necessary.
20
20
21
21
### Code generation
22
22
23
-
Follow the documentation for the [code generation](/docs/guide/intro) in general and [CLI](/docs/cli/generate) or the [Studio](/docs/studio/intro) tools.
23
+
Follow the documentation for the [code generation](/docs/guide/intro) in general and [CLI](/docs/tools/cli/generate) or the [Studio](/docs/tools/studio/intro) tools.
24
24
Or try first the [quick start guide](../quickstart/index.md) which shows how to prepare api and generate code out of it.
25
25
26
26
:::tip
@@ -50,11 +50,11 @@ Features generate a view model for the _API_ definition. This can be used to imp
50
50
51
51
Features can be used in combination with _API_ and add more functionality on top, like simulation support (see [olink](olink.md#simulation))
52
52
53
-
-[olink](olink.md) - provides a client and server adapters for each interface, that can be connected to any of the other technology templates with support for [ObjectLink](/docs/advanced/objectlink/intro). Use this feature to connect with ApiGear simulation tools.
53
+
-[olink](olink.md) - provides a client and server adapters for each interface, that can be connected to any of the other technology templates with support for [ObjectLink](/docs/advanced/protocols/objectlink/intro). Use this feature to connect with ApiGear simulation tools.
54
54
- examples_olink - examples of generated code for the olink feature. Contains:
55
55
- `olinkserver` shows use of your interfaces as an olink services.
56
56
- `olinkclient` shows use of your interfaces as an olink clients.
57
-
-[monitor](monitor.md) - generates a middle-ware layer which logs all API events to the [CLI](/docs/cli/intro) or the [Studio](/docs/studio/intro)
57
+
-[monitor](monitor.md) - generates a middle-ware layer which logs all API events to the [CLI](/docs/tools/cli/intro) or the [Studio](/docs/tools/studio/intro)
58
58
-[MQTT](mqtt.md)_experimental_ - provides minimal working adapters for MQTT client and service side for each interfaces. Check also MQTT in other technology templates that supports it.
59
59
- examples_mqtt - examples of generated code for the olink feature. Contains:
60
60
- `mqttserver` shows use of your interfaces with mqtt adapted for your services.
Copy file name to clipboardExpand all lines: docs/docs/features/monitor.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ import helloWorldModuleComponent from '!!raw-loader!./data/helloworld.module.yam
7
7
8
8
# Monitor
9
9
10
-
Use the monitor feature to examine the interface calls, state and signals during runtime. With this feature you obtain a monitor client and a monitored version of your interfaces. The monitoring server is embedded into the [ApiGear Studio](/docs/studio/intro) and [CLI version](/docs/cli/intro).
10
+
Use the monitor feature to examine the interface calls, state and signals during runtime. With this feature you obtain a monitor client and a monitored version of your interfaces. The monitoring server is embedded into the [ApiGear Studio](/docs/tools/studio/intro) and [CLI version](/docs/tools/cli/intro).
11
11
More details on [monitoring](/docs/advanced/monitor/intro)
Copy file name to clipboardExpand all lines: docs/docs/features/olink.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ import Figure from '../figure'
13
13
14
14
# Olink
15
15
16
-
This feature provides a _client_ and a _server_ adapter for your interfaces for the [ObjectLink](/docs/advanced/objectlink/intro) protocol. It allows you to connect different applications using the same or different technologies (check all of our [templates](/docs/sdk/intro)).
16
+
This feature provides a _client_ and a _server_ adapter for your interfaces for the [ObjectLink](/docs/advanced/protocols/objectlink/intro) protocol. It allows you to connect different applications using the same or different technologies (check all of our [templates](/docs/sdk/intro)).
17
17
18
18
Use an _OLink client_ instead of your interface implementation to connect to a remote service, or to a the [ApiGear simulation](olink#simulation). Use an _OLink server adapter_ to expose your interface implementation as a remote service.
19
19
@@ -26,7 +26,7 @@ If you want quickly start working with them go to use sections of [client](olink
26
26
27
27
### Apigear ObjectLink protocol and ObjectLink core library
28
28
29
-
The [ObjectLink](/docs/advanced/objectlink/intro) protocol is a lightweight websocket based protocol for Objects described with an interface. It allows connecting a client object with a server object, and perform remote operations like: remote property change request (client) or notifications on property changed (server), inform about signal emission (server) and allows requesting a remote method call (client) and delivering a response to the caller (server).
29
+
The [ObjectLink](/docs/advanced/protocols/objectlink/intro) protocol is a lightweight websocket based protocol for Objects described with an interface. It allows connecting a client object with a server object, and perform remote operations like: remote property change request (client) or notifications on property changed (server), inform about signal emission (server) and allows requesting a remote method call (client) and delivering a response to the caller (server).
30
30
31
31
The Olink feature for your interface uses a library [ObjectLink core](https://github.com/apigear-io/objectlink-core-cpp), common for cpp based templates. The provided `CMakeLists` already contain all the dependencies, so you don't have to add it manually.
Files `📜helloservice.h` and `📜helloservice.h` contain the olink server adapter for the `Hello` interface - the `HelloService` class.
173
173
174
-
It implements an `IObjectSource` interface (from [ObjectLink core](https://github.com/apigear-io/objectlink-core-cpp)), which wraps your `Hello` and exposes it for remote usage with the [ObjectLink](/docs/advanced/objectlink/intro) protocol. It handles all the network requests, and calls your local object.
174
+
It implements an `IObjectSource` interface (from [ObjectLink core](https://github.com/apigear-io/objectlink-core-cpp)), which wraps your `Hello` and exposes it for remote usage with the [ObjectLink](/docs/advanced/protocols/objectlink/intro) protocol. It handles all the network requests, and calls your local object.
175
175
176
176
When creating the `HelloService` you need to provide the local `IHello` service object, you want to expose to clients.
The simulation can be used to test, demonstrate or develop applications without the need to have the actual service available.
235
-
The simulation server is integrated into the [ApiGear studio](/docs/studio/intro) and the [CLI](/docs/cli/simulate).
235
+
The simulation server is integrated into the [ApiGear studio](/docs/tools/studio/intro) and the [CLI](/docs/tools/cli/simulate).
236
236
237
237
For simulating you will use [simulation scenarios](/docs/advanced/simulation/scenario) They allow to define sequences of actions. The actions can change the property values of the service or emit signals. The scenarios can be written using a YAML schema.
0 commit comments