Skip to content

Commit

Permalink
Updates for docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
eao197 committed Jun 30, 2023
1 parent 74a87cf commit b6b3f50
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ At the current moment so5extra contains the following components:
* so_5::extra::mboxes::proxy. A proxy-mbox which delegates all calls to the underlying actual mbox. Such proxy simplifies development of custom mboxes.
* so_5::extra::mboxes::retained_msg. An implementation of mbox which holds the last sent message and automatically resend it to every new subscriber for this message type;
* so_5::extra::mboxes::round_robin. An implementation of *round-robin* mbox which performs delivery of messages by round-robin scheme;
* so_5::extra::mboxes::unique_subscribers. A variant of Multi-Producer/Single-Consumer mbox, that allows having many different subscribers if all of those subscribers are subscribed to different message types;
* so_5::extra::mchains::fixed_size. An implementation of fixed-size mchain which capacity is known at the compile-time;
* so_5::extra::revocable_msg. A set of tools for sending messages/signals those can be revoked;
* so_5::extra::revocable_timer. A set of tools for sending delayed/periodic messages/signals those can be revoked;
Expand All @@ -31,16 +30,16 @@ More features can be added to so5extra in future. Some of so5extra's features ca

## The Old-School Way

### Obtaining
### Obtaining

so5extra can be obtained from source-code repository via Git. For example:

git clone https://github.com/stiffstream/so5extra

so5extra can also be downloaded from the corresponding [Releases](https://github.com/Stiffstream/so5extra/releases) section on GitHub. There are two types of achives with so5extra:

* archives with so5extra sources only (with names like `so5extra-1.4.0.tar.xz`);
* archives with so5extra and all dependecies, like SObjectizer and Asio. These archives have names like `so5extra-1.4.0-full.tar.xz`).
* archives with so5extra sources only (with names like `so5extra-1.6.0.tar.xz`);
* archives with so5extra and all dependecies, like SObjectizer and Asio. These archives have names like `so5extra-1.6.0-full.tar.xz`).

If so5extra is got from repository or downloaded as archive without dependecies inside then obtaining of dependecies could be necessary. It can be done via mxxruexternals command:

Expand Down Expand Up @@ -107,7 +106,7 @@ It can be also necessary to add public-conan remote:
Add so5extra to conanfile.txt of your project:

[requires]
so5extra/1.4.0@stiffstream/stable
so5extra/1.6.0@stiffstream/stable

It also may be necessary to specify shared option for SObjectizer. For example, for build SObjectizer as a static library:

Expand Down
12 changes: 12 additions & 0 deletions dev/mainpage.dox
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,18 @@
*
* \section so_5_extra_versions so_5_extra Version Info
*
* \subsection so_5_extra_v1_6_0 v.1.6.0
*
* Adaptation to SObjectizer v.5.8.0.
*
* \attention
* so5extra-1.6.0 can't be used with SObjectizer versions prior to v.5.8.0.
*
* unique_subscribers mbox is now a part of SObjectizer-5.8.0.
* The header file `so_5_extra/mboxes/unique_subscribers.hpp` and
* the function `so_5::extra::mboxes::unique_subscribers::make_mbox`
* are kept just for compatibility reasons.
*
* \subsection so_5_extra_v1_5_2 v.1.5.2
*
* New type of mbox is introduced: so_5::extra::mboxes::inflight_limit.
Expand Down

0 comments on commit b6b3f50

Please sign in to comment.