Skip to content

Commit e73fd0a

Browse files
committed
Minor doc updates
1 parent f7fb7a6 commit e73fd0a

File tree

5 files changed

+34
-16
lines changed

5 files changed

+34
-16
lines changed

example/sample-projects/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Sample Projects
2+
3+
Remote delegates invoke a target function that runs in a separate processor or process. Transport and serialization libraries are configurable.
4+
5+
Each sample project focuses on a transport-serialization pair, but you can freely mix and match any transport with any serializer.
6+
7+
## External Dependencies
8+
9+
The following remote delegate sample projects have no external library dependencies:
10+
11+
* [bare-metal](./bare-metal/) - simple remote delegate app on Windows and Linux.
12+
* [system-architecture-no-deps](./system-architecture-no-deps/) - complex remote delegate client/server apps using UDP on Windows or Linux.
13+
14+
All other projects require external 3rd party library support. See [Examples Setup](../../docs/DETAILS.md#examples-setup) for external library installation setup.
15+
16+
## Build
17+
18+
See [Sample Projects](../../docs/DETAILS.md#sample-projects) for details on building and running sample projects.

example/sample-projects/nnq-bitsery/main.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
/// @see https://github.com/endurodave/DelegateMQ
33
/// David Lafreniere, 2025.
44
///
5-
/// @brief NNG (nanomsg-next-gen) and MsgPack with remote delegates examples.
5+
/// @brief NNG (nanomsg-next-gen) and Bitsery with remote delegates examples.
66

77
#include "sender.h"
88
#include "receiver.h"

src/delegate-mq/delegate/DelegateAsync.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
/// * `std::function` compares the function signature type, not the underlying object instance.
4343
/// See `DelegateFunction<>` class for more info.
4444
///
45-
/// Code within `<common_code>` and `</common_code>` is updated using sync_src.py. Manually update
45+
/// Code within `<common_code>` and `</common_code>` is updated using src_dup.py. Manually update
4646
/// the code within the `DelegateFreeAsync` `common_code` tags, then run the script to
4747
/// propagate to the remaining delegate classes to simplify code maintenance.
4848
///
@@ -433,7 +433,7 @@ class DelegateMemberAsync<TClass, RetType(Args...)> : public DelegateMember<TCla
433433

434434
DelegateMemberAsync() = default;
435435

436-
/// @brief Bind a const member function to the delegate.
436+
/// @brief Bind a member function to the delegate.
437437
/// @details This method associates a member function (`func`) with the delegate.
438438
/// Once the function is bound, the delegate can be used to invoke the function.
439439
/// @param[in] object The target object instance.
@@ -445,7 +445,7 @@ class DelegateMemberAsync<TClass, RetType(Args...)> : public DelegateMember<TCla
445445
BaseType::Bind(object, func);
446446
}
447447

448-
/// @brief Bind a member function to the delegate.
448+
/// @brief Bind a const member function to the delegate.
449449
/// @details This method associates a member function (`func`) with the delegate.
450450
/// Once the function is bound, the delegate can be used to invoke the function.
451451
/// @param[in] object The target object instance.
@@ -457,7 +457,7 @@ class DelegateMemberAsync<TClass, RetType(Args...)> : public DelegateMember<TCla
457457
BaseType::Bind(object, func);
458458
}
459459

460-
/// @brief Bind a const member function to the delegate.
460+
/// @brief Bind a member function to the delegate.
461461
/// @details This method associates a member function (`func`) with the delegate.
462462
/// Once the function is bound, the delegate can be used to invoke the function.
463463
/// @param[in] object The target object instance.
@@ -469,7 +469,7 @@ class DelegateMemberAsync<TClass, RetType(Args...)> : public DelegateMember<TCla
469469
BaseType::Bind(object, func);
470470
}
471471

472-
/// @brief Bind a member function to the delegate.
472+
/// @brief Bind a const member function to the delegate.
473473
/// @details This method associates a member function (`func`) with the delegate.
474474
/// Once the function is bound, the delegate can be used to invoke the function.
475475
/// @param[in] object The target object instance.

src/delegate-mq/delegate/DelegateAsyncWait.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
/// * `std::function` compares the function signature type, not the underlying object instance.
4949
/// See `DelegateFunction<>` class for more info.
5050
///
51-
/// Code within `<common_code>` and `</common_code>` is updated using sync_src.py. Manually update
51+
/// Code within `<common_code>` and `</common_code>` is updated using src_dup.py. Manually update
5252
/// the code within the `DelegateFreeAsyncWait` `common_code` tags, then run the script to
5353
/// propagate to the remaining delegate classes to simplify code maintenance.
5454
///
@@ -548,7 +548,7 @@ class DelegateMemberAsyncWait<TClass, RetType(Args...)> : public DelegateMember<
548548

549549
DelegateMemberAsyncWait() = default;
550550

551-
/// @brief Bind a const member function to the delegate.
551+
/// @brief Bind a member function to the delegate.
552552
/// @details This method associates a member function (`func`) with the delegate.
553553
/// Once the function is bound, the delegate can be used to invoke the function.
554554
/// @param[in] object The target object instance.
@@ -563,7 +563,7 @@ class DelegateMemberAsyncWait<TClass, RetType(Args...)> : public DelegateMember<
563563
BaseType::Bind(object, func);
564564
}
565565

566-
/// @brief Bind a member function to the delegate.
566+
/// @brief Bind a const member function to the delegate.
567567
/// @details This method associates a member function (`func`) with the delegate.
568568
/// Once the function is bound, the delegate can be used to invoke the function.
569569
/// @param[in] object The target object instance.
@@ -578,7 +578,7 @@ class DelegateMemberAsyncWait<TClass, RetType(Args...)> : public DelegateMember<
578578
BaseType::Bind(object, func);
579579
}
580580

581-
/// @brief Bind a const member function to the delegate.
581+
/// @brief Bind a member function to the delegate.
582582
/// @details This method associates a member function (`func`) with the delegate.
583583
/// Once the function is bound, the delegate can be used to invoke the function.
584584
/// @param[in] object The target object instance.
@@ -593,7 +593,7 @@ class DelegateMemberAsyncWait<TClass, RetType(Args...)> : public DelegateMember<
593593
BaseType::Bind(object, func);
594594
}
595595

596-
/// @brief Bind a member function to the delegate.
596+
/// @brief Bind a const member function to the delegate.
597597
/// @details This method associates a member function (`func`) with the delegate.
598598
/// Once the function is bound, the delegate can be used to invoke the function.
599599
/// @param[in] object The target object instance.

src/delegate-mq/delegate/DelegateRemote.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
/// * `std::function` compares the function signature type, not the underlying object instance.
4141
/// See `DelegateFunction<>` class for more info.
4242
///
43-
/// Code within `<common_code>` and `</common_code>` is updated using sync_src.py. Manually update
43+
/// Code within `<common_code>` and `</common_code>` is updated using src_dup.py. Manually update
4444
/// the code within the `DelegateFreeRemote` `common_code` tags, then run the script to
4545
/// propagate to the remaining delegate classes to simplify code maintenance.
4646
///
@@ -634,7 +634,7 @@ class DelegateMemberRemote<TClass, RetType(Args...)> : public DelegateMember<TCl
634634

635635
DelegateMemberRemote() = default;
636636

637-
/// @brief Bind a const member function to the delegate.
637+
/// @brief Bind a member function to the delegate.
638638
/// @details This method associates a member function (`func`) with the delegate.
639639
/// Once the function is bound, the delegate can be used to invoke the function.
640640
/// @param[in] object The target object instance.
@@ -646,7 +646,7 @@ class DelegateMemberRemote<TClass, RetType(Args...)> : public DelegateMember<TCl
646646
BaseType::Bind(object, func);
647647
}
648648

649-
/// @brief Bind a member function to the delegate.
649+
/// @brief Bind a const member function to the delegate.
650650
/// @details This method associates a member function (`func`) with the delegate.
651651
/// Once the function is bound, the delegate can be used to invoke the function.
652652
/// @param[in] object The target object instance.
@@ -658,7 +658,7 @@ class DelegateMemberRemote<TClass, RetType(Args...)> : public DelegateMember<TCl
658658
BaseType::Bind(object, func);
659659
}
660660

661-
/// @brief Bind a const member function to the delegate.
661+
/// @brief Bind a member function to the delegate.
662662
/// @details This method associates a member function (`func`) with the delegate.
663663
/// Once the function is bound, the delegate can be used to invoke the function.
664664
/// @param[in] object The target object instance.
@@ -670,7 +670,7 @@ class DelegateMemberRemote<TClass, RetType(Args...)> : public DelegateMember<TCl
670670
BaseType::Bind(object, func);
671671
}
672672

673-
/// @brief Bind a member function to the delegate.
673+
/// @brief Bind a const member function to the delegate.
674674
/// @details This method associates a member function (`func`) with the delegate.
675675
/// Once the function is bound, the delegate can be used to invoke the function.
676676
/// @param[in] object The target object instance.

0 commit comments

Comments
 (0)