EXAMPLES.md

uniflow example gallery

Language: 한국어 | English

Six reference examples are provided identically in C++ / Python / C# (except weather_llm). Each has a detailed page in its own folder and covers a specific uniflow capability.

#	Example	Focus	Render	Python	C#
1	pick_and_place	Task units + orchestrator state polling + async-poll acks (reference)	dual	py	cs
2	city_traffic	dozens of modules on one thread + lock-free shared World	dual	py	cs
3	simulator	VirtualClock scale/freeze + the renderer is a flow + lock-free snapshot	console	py	cs
4	message_dispatch	routing by message kind + lock-free mailbox + async poll	console	py	cs
5	queue_drain	single-thread producer/consumer + park/relaunch wake	console	py	cs
6	shared_ostream	one pump = lock-free shared state (minimal)	console	py	cs
+	weather_llm	two async stages chained, pump never blocks on the network (C++ only)	console	-	-

"dual" means a Win32 GUI on Windows and an ANSI console on Linux/macOS (UF_RENDER=console forces console on Windows too). The rest are console everywhere and run with nothing to install.

Build / run:

# C++ console example (Linux/macOS)
g++ -std=c++17 -O2 -I cpp cpp/examples/<name>/*.cpp -o <name> -pthread
# Python
python python/examples/<name>.py
# C#
dotnet run --project cs/examples/<name>

On Windows the dual-render examples (pick_and_place / city_traffic) open as .vcxproj, and console examples build with cl /std:c++17 /EHsc /I cpp cpp\examples\<name>\*.cpp /Fe:<name>.exe.

---

Suggested reading order

If you are new: README Quick Start -> TUTORIAL.md -> 6 shared_ostream -> 3 simulator -> 5 queue_drain -> 4 message_dispatch -> 2 city_traffic -> 1 pick_and_place.

To see the overall shape first, skim city_traffic or pick_and_place, then return to the tutorial.