diff --git a/LCS/Messaging/doc/Messaging.md b/LCS/Messaging/doc/Messaging.md index ceaa053757fadabc0f46328de4672ab3102dc372..61bd41b8df2b3b39492d62bbea5762fdc1254de4 100644 --- a/LCS/Messaging/doc/Messaging.md +++ b/LCS/Messaging/doc/Messaging.md @@ -3,24 +3,36 @@ ## GENERAL ### Description -The C++ messaging library can be used to send and receive QPID messages in C++ code. The Python code provides a template for mini services that communicate by RPCs. +This module contains code for the C++ library `libmessaging.so` and a base class for Python mini services. The C++ library can send and receive QPID messages while the Python base class communication is done through RPCs. ### Author/Owner -Jorrit Schaap <schaap@astron.nl> -Jan David Mol <mol@astron.nl> +- Jorrit Schaap <schaap@astron.nl> +- Jan David Mol <mol@astron.nl> ### Overview -*TODO* +The Python class `AbstractBusListener` is the base class for Python services that are listening on the QPID bus for a certani type of message. The following Python services inherit from `AbstractBusListener`: + +- `Service`: This is the base class for RPC micro services. +- `TriggerNotificationListener` +- `OTDBBusListener` +- `IngestBusListener` +- `DataManagementBusListener` +- `RABusListener` +- `RATaskSpecifiedBusListener` +- `RADBBusListener` + +The `libmessaging.so` library is used by the following modules: + +- `WinCCPublisher` - - - ## DEVELOPMENT ### Analyses -*Add non-technical information and functional considerations here, like user requirements and links to minutes of -meetings with stakeholders.* +*TODO* ### Design -*Add technical considerations and design choices here* +*TODO* ### Source Code [LCS/Messaging](https://svn.astron.nl/LOFAR/trunk/LCS/Messaging)