diff --git a/docs/site/docs/consumer-clients.md b/docs/site/docs/consumer-clients.md index 162b0d1ee2a36da9d02d5be61e1f728abd0e801b..b4f597d5341ad61b584d84482f4afd182c9f349e 100644 --- a/docs/site/docs/consumer-clients.md +++ b/docs/site/docs/consumer-clients.md @@ -12,14 +12,14 @@ Consumer API is available for C++ and Python and has the following main function - Multiple instances can be created (also within a single application) to receive data from different sources - An instance id and pipeline step id can be set to allow pipeline monitoring - A beamtime token is used for access control -- If needed (mainly for get_next_XX operations), create a consumer group that allows to process messages independently from other groups +- If needed (mainly for 'get_next_XX' operations), create a consumer group that allows to process messages independently from other groups - Receive messages from a specific stream (you can read more [here](data-in-asapo) about data in ASAPO) - - get_next to receive process messages one after another without need to know message indexes + - 'get_next' to receive process messages one after another without need to know message indexes - Consumer API returns a message with index 1, then 2, ... as they were set by producer. - This also works in parallel so that the payload is distributed within multiple consumers within same consumer group or between threads of a single consumer instance. In parallel case order of indexes of the messages is not determined. - Optionaly it can return messages in their arrival order (return next available message). It is useful for the fast data-processing agnostic to message index. - - get_last to receive last available message - for e.g. live visualisation - - get_by_id to get message by index, providing random access + - 'get_last' to receive last available message - for e.g. live visualisation + - 'get_by_id' to get message by index, providing random access - Make queries based on metadata contained in a message - returns all messages in a stream with specific metadata. A subset of SQL language is used diff --git a/docs/site/docs/cookbook/simple-producer.mdx b/docs/site/docs/cookbook/simple-producer.mdx index 3c176b65d9ef1dafff7ae396c7213eb691dfc2c1..aec27435268f3cb610cbb9b5136f3d2ccf31bc58 100644 --- a/docs/site/docs/cookbook/simple-producer.mdx +++ b/docs/site/docs/cookbook/simple-producer.mdx @@ -6,7 +6,7 @@ title: Simple Producer import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -This example produces a simple message. This page provides snippets for simple producer for both Python and C++. You can go to BitBucket to see the whole example at once. In the referenced file there is a working example ready for launch. +This example produces a simple message. This page provides snippets for simple producer for both Python and C++. You can click the link on the bottom right of the code snippets to see the whole example at once. In the referenced file there is a working example ready for launch. First step is to create an instance of the producer.