Repository files navigation

rotor is event loop friendly C++ actor micro framework,githubabfgitee

telegram

• minimalistic loop agnostic core
• erlang-like hierarchical supervisors,seethisandthis
• various event loops supported (wx, boost-asio, ev) or planned (uv, gtk, etc.)
• asynchronous message passing interface
• request-response messaging with cancellation capabilities,see
• MPMC (multiple producers multiple consumers) messaging, aka pub-sub
• cross-platform (windows, macosx, linux)
• inspired byThe Reactive Manifesto andsobjectizer

Setup: Intel Core i7-8550U, Void Linux 5.15.

(1) Backend-independent; Can be measured withexamples/boost-asio/ping-pong-single-simple,examples/ev/ping-pong-ev.

(2) Does not apply to wx-backend; can be measured withexamples/thread/ping-pong-thread,examples/boost-asio/ping-pong-2-threads,examples/ev/ping-pong-ev-2-threads.

(3) Backend-independent inter-thread messaging when build withROTOR_BUILD_THREAD_UNSAFE=True.rotor objects (messagesand actors) cannot be accessed from different threads, cross-thread message sending facility cannot be used. Thisoption is mainly targeted for single-threaded apps.

MIT

Please read tutorial, design principles and manualhere

Looking for something actor-flavored, but suitable for embedded applications?Take a look into myrotor-lightproject.

• [feature] addroute() andredirect() high-level actor methods, whichprovide convenient API overmake_routed_message() introduced inv0.32

• [breaking] asio supervisor uses steady clock instead of system clock (aka deadline_timer)

• [feature] improve c++20 support
• [workaround, fltk] more realiable message delivery for fltk backend. Fltkmight "forget" to invoke scheduledawakes after shutdown process, which leadsto minor memory leaks
• [cmake, breaking] useCMAKE_CURRENT_SOURCE_DIR instead ofCMAKE_SOURCE_DIR
• [cmake, breaking] configure option renamedBUILD_BOOST_ASIO =>ROTOR_BUILD_ASIO
• [cmake, breaking] configure option renamedBUILD_WX =>ROTOR_BUILD_WX
• [cmake, breaking] configure option renamedBUILD_EV =>ROTOR_BUILD_EV
• [cmake, breaking] configure option renamedBUILD_FLTK =>ROTOR_BUILD_FLTK
• [cmake, breaking] configure option renamedBUILD_THREAD =>ROTOR_BUILD_THREAD
• [cmake, breaking] configure option renamedBUILD_DOC =>ROTOR_BUILD_DOC
• [cmake, breaking] configure option renamedBUILD_THREAD_UNSAFE =>ROTOR_BUILD_THREAD_UNSAFE
• [cmake, new] configure option addedROTOR_BUILD_TESTS (instead ofENABLE_TESTING)

• [cmake, bugfix, win32] addws2_32 lib forrotor_asio win32 build

• [feature] addedmake_routed_message() free function.The function is used for "synchronized" message post-processing, i.e. once amessage has been delivered and processed by all recipients (can be zero),then it is routed to the specifed address to do cleanup.

Example:

1. an db-actor and opens transaction and reads data (i.e. asstd::string_views, owned by db)
2. actors sends broadcast message to all interesting parties to deserialized data
3. after the step 2 is finished the db-actor closes transaction and releases acquired resources.

Themake_routed_message is needed to perform recipient-agnostic 3rd step.

The alternative is to create a copy (snapshot) of data (i.e.std::stringinstead ofstd::string_view), but that seems redundant.

• [improvement, breaking] addvoid* parameter tomessage_visitor_t

• [bugfix, fltk] more realiable message delivery for fltk backend

• [feature] addedfltk-backend
• [feature, conan]enable_fltk option which add fltk-support
• [example] added/examples/ping-pong-fltk.cpp andexamples/ping-pong-fltk_and_thread.cpp
• [bugfix]wx-backend building and testing
• [improvement, breaking] output directories are set tobin for cmake
• [improvement, breaking]actor_base_t::make_error() is marked as const

• [bugfix] fix segfault in delivery plugin in debugging mode(try to set envROTOR_INSPECT_DELIVERY=99 to see)

• [cmake, bugfix] add missing header into installation

• [feature] new interfacemessage_visitor_t
• [feature] new interfacemessage_stringifier_t and the default implementationdefault_stringifier_t which allows to dump messages. It is not a production buta diagnostic/debug tool, due to performance restrictions.
• [feature]system_context_t provides a reference to defaultmessage_stringifier_t;it is possible to have a custom one
• [feature, breaking]extended_error_t holds a reference to a request message,which caused an error
• [examples, tests, win32] fixev examples and tests
• [example] modernizeexamples/thread/sha512.cpp to use recentopenssl version
• [breaking] cmake requirements are lowered to3.15
• [breaking] fix minor compilation warnings

• [feature]start_timer callback not only method, but any invocable
• [feature, conan]enable_ev option which addlibev
• [breaking, conan]boost minimum version1.83.0
• [testing, conan] removecatch2 from sources and make it dependencies
• [bugfix, breaking] make plugins more dll-friendly
• [breaking]cmake minimum version3.23
• [breaking] renameregistry_t::revese_map_t revese_map ->registry_t::reverse_map_t reverse_map
• [breaking] rename structcancelation_t ->cancellation_t
• [doc] fix multiple typos

• [bugfix] avoid response messages loose their order relative to regular message
• [bugfix, example] add missing header

• [feature] improve inter-thread messaging performance up to 15% by usingboost::unordered_mapinstead ofstd::unordered_map
• [bugfix, breaking] avoid introducing unnecessary event loops latency by intensive polling ofrotor queues; affectsasio andev loops
• [bugfix]registry_plugin_t, allow to discover aliased services (#46)

• [bugfix] fix compilation issues ofmessages.cpp on some platforms
• [bugfix, msvc] fix compilation issues ofregistry plugin forshared libraryon msvc-16+

• [feature] possibly to install viaconan center
• [feature, breaking] possibility to buildrotor as shared library
• [feature] add shutdown flag checker (seemy blog)
• [bugfix] requests do not outlive actors (i.e. they are cancelled onshutdown_finish)
• [example] there is my another open-source projectsyncspirit,which usesrotor under hood. I recommend to look at it, if the shipped examples are too-trivial, anddon't give you an architectural insight of usingrotor.

• [improvement] preliminary support ofconan package manager
• [bugfix] fix compilation warnings on Windows/MSVC
• [bugfix] add missing header forrotor::thread installation

• [improvement] superviser can createspawner, which has a policy to auto-spawnsnew actor instance if previous instance has been shutdown. This is similar toescalate_failuresupervising in erlang,seededicated article
• [improvement] actor can nowautoshutdown_supervisor(), when it shutdown
• [improvement] actor can nowescalate_failure(), i.e. trigger shutdown own supervisorwhen it finished with failure
• [improvement] messages delivery order is persevered per-locality (see issue #41)
• [example]examples/thread/ping-pong-spawner (new)
• [example]examples/autoshutdown (new)
• [example]examples/escalate-failure (new)
• [documentation] updatedDesign principles
• [documentation] updatedExamples
• [documentation] updatedIntroduction

• [improvement] performance improvement in inter-thread (+20%) and cross-thread messaging
• [bugfix] supervisor does not shut self down in rare conditions, when it fails to initialize self
• [bugfix] link_server plugin should ignore unlink_notifications
• [bugfix] avoid cycle (i.e. memleak) in rare cases when supervisor is shutdown, but an externalmessage arrives for processing

• [improvement] addstatic_assert fornoexcept check of a hanler signature
• [improvement] addgitee mirror
• [bugfix] fix potential use-after-free inev backend

• [bugfix] fix installation issues with cmake (thanks to @melpon)
• [bugfix] fix missing header (thanks to @melpon)
• [ci] drop travis-ci in the sake of circle-ci

• [improvement] significant message throughtput increase forstd::thread,boost-asioandev backends (upto 5x times)
• [improvement]extended_error can now access to root reason
• [improvement] delivery plugin in debug mode dumps discovery requests and responses
• [improvement/breaking] more details on fatal error (system_context)
• [example]examples/thread/ping-pong-thread.cpp (new)
• [example]examples/ev/ping-pong-ev-2-threads (new)

• [bugfix]lifetime_plugin_t do not unsubscribe from foreign to me subscriptions
• [bugfix]foreigners_support_plugin_t more safely deliver a message for a foreignsubscriber (actor)

• the dedicated article with highlights:en andru
• [improvement] actor identity has been introduced. It can be configured or generated viaaddress_maker plugin
• [improvement]actor::do_shutdown() - optionally takes shutdown reason
• [improvement/breaking] instead of usingstd::error_code theextended_error classis used. It wrapsstd::error_code, provides string context and pointer to the nextextended_error cause. This greatly simplifies error tracking of errors. Every responsenow containsee field instead ofec.
• [improvement]actor has shutdown reason (in form ofextended_error pointer)
• [improvement] delivery plugin in debug mode it dumps shutdown reason in shutdown triggermessages
• [improvement] actor identity hason_unlink method to get it know, when it has beenunlinked from server actor
• [improvement] addresources plugin for supervisor
• [breaking] all responses now haveextended_error pointer instead ofstd::error_code
• [breaking]shutdown_request_t andshutdown_trigger_t messages how haveshutdown reason (in form ofextended_error pointer)
• [bugfix]link_client_plugin_t do not invoke custom callback, before erasing requestin case of failure
• [bugfix]child_manager_plugin_t reactivate self if a child was created from otherplugin.
• [bugfix]registry actor incorrectly resolves postponed requests to wrong addresses

• [improvement] delivery plugin in debug mode dumps discarded messages
• [breaking]state_response_t has been removed
• [bugfix] allow to acquire & release resources in viaresources_plugin_t, duringother plugin configuration
• [bugfix] foreigners_support_plugin_t did not deactivated self properly, causedassertion fail on supervisor shutdown, when there was foreign subscriptions
• [bugfix] link_client_plugin_t did not notified linked server-actors, if its actor isgoing to shutdown; now server-actors are requested to unlink
• [bugfix] starter_plugin_t sometimes crashed when subscription confirmation messagearrives when actor is in non-initializing phase (i.e. shutting down)
• [bugfix] root supervisor is not shutdown properly when it is linked as "server"

• [improvement] addedstd::thread backend (supervisor)
• [bugfix] active timers, if any, are cancelled upon actor shutdown finish
• [bugfix] supervisor shutdown message is lost in rare cases right afterchild actor start
• [example]examples/thread/sha512.cpp (new)
• [documentation] updatedEvent loops & platforms
• [documentation] updatedPatterns withBlocking I/O multiplexing
• [deprecated] state_response_t, state_request_t will be removed in v0.13

• [improvement] when supervisor shuts self down due to child init failure,the supervisor init error code is "failure escalation"
• [documentation] updatedAdvanced examples,
• [bugfix] when actor shuts self down all its timers are properlycancelled
• [bugfix] in rare case supervisor starts, event if child failed to init
• [bugfix] asio: more correct timers cancellation implementation
• [bugfix] ev: more correct shutdown (avoid memory leaks in rare cases)

• [improvement/breaking] Generic timers interface
• [improvement] Request cancellation support
• [improvement] addedmake_response methods when message should be created, butsend later delayed
• [improvement] more debug information in message delivery plugin
• [documentation] Integration with event loops
• [documentation] Requests cancellation and timers are demonstrated in theAdvanced Examples section
• [example]examples/boost-asio/ping-pong-timer.cpp (new)
• [example]examples/boost-asio/beast-scrapper.cpp (updated)
• [bugfix] avoid double configuration of a plugin in certain cases when interactingwith resources plugin
• [bugfix] more correct cmake installation (thanks to Jorge López Tello, @LtdJorge)

• the dedicated article with highlights:en andru
• [improvement] rewritten whole documentation
• [improvement/breaking] plugin system where introduced for actors instead ofbehaviors
• [improvement]actor_config_t was introduced, which now holds pointer tosupervisor, init and shutdown timeouts
• [improvement]builder pattern was introduced to simplify actors construction
• [breaking]supervisor_config_t was changed (inherited fromactor_config_t)
• [breaking]actor_base_t andsupervisor_t constructors has changed - nowappropriate config is taken as single parameter. All descendant classes shouldbe changed
• [breaking] if a custom config type is used for actors/supervisors, theyshould defineconfig_t inside the class, and templatedconfig_builder_t.
• [breaking] supervisor in actor is now accessible via pointer instead ofreference
• [bugfix]supervisor_ev_t not always correctly released EV-resources, whichlead to leak
• [bugfix]actor_base_t can be shutted down properly even if it did notstarted yet

• [bugfix] message's arguments are more correctly forwarded
• [bugfix] actor's arguments are more correctly forwarded in actor'screation inrotor::supervisor_t androtor::asio::supervisor_asio_t
• [bugfix]rotor::asio::forwarder_t now more correctly dispatchesboost::asio events to actor methods; e.g. it works correctly now withasync_accept method ofsocket_acceptor

• [improvement] more modern cmake usage

• [improvement] registry actor was added to allow via name/address runtimematching do services discovery
• [improvement, breaking] minor changes in supervisor behavior: now itis considered initialized when all its children confirmed initialization
• [improvement]supervisor_policy_t was introduced to control supervisorbehavior on a child-actor startup failure
• [example]examples/ev/pong-registry.cpp how to use registry
• [doc] patterns/Registry was added

• [improvement] response can be inherited fromrotor::arc_base, to allowforwarding requests without copying it (i.e. just intrusive pointer is created)
• [example]examples/boost-asio/beast-scrapper.cpp has been added; itdemonstrates an app with pool of actor workers with request-response forwarding

• [improvement] therequest-response approach is integrated to support basicreliable messaging: response notification failure will be delivered,if the expected response will not arrive in-time
• [improvement] lambda subscribers are supported
• [improvement] actor behavior has been introduced to offload actor'sinterface
• [breaking] supervisor is constructed with help ofsupervisor_config_t,which contains shutdown timeout value
• [breaking] supervisor does not spawns timeout timer for overall shutdownprocedure, instead per-child timers are spawned. The root supervisorthe same way monitors child-supervisor shut down
• [breaking] supervisorcreate_actor method now takes child maxinit time value. If it does not confirm, the child actor will be askedfor shut down.
• [breaking] shutdown request sent to an child actor now timeout-trackedby supervisor. The message type has changed tomessage::shutdown_request_t
• [breaking] init request sent to an child actor now timeout-trackedby supervisor. The message type has changed tomessage::init_request_t
• [breaking] actor's state request message type nowmessage::state_request_t,which follows the generic request/response pattern. The response typeis nowmessage::state_response_t.
• [breaking] {asio, ev, ws} supervisor configs are renamed to havecorresponding suffix.

• [improvement] locality notion was introduced, which led to possibilityto build supervising trees, seeblog-cpp-supervisors
• [breaking] theoutbound field inrotor::supervisor_t was renamed just toqueue
• [breaking]rotor::address_t now containsconst void* locality
• [breaking]rotor::asio::supervisor_config_t now containsstd::shared_ptr tostrand, instead of creating private strandfor each supervisor
• [bugfix] redundantdo_start() method inrotor::supervisor_t wasremoved, since supervisor now is able to start self after completinginitialization.
• [bugfix]rotor::supervisor_t sendsinitialize_actor_t to selfto advance own state toINITIALIZED via common actor mechanism,instead of changing state directly on early initialization phase(do_initialize)
• [bugfix]rotor::asio::forwarder_t now more correctly dispatchesboost::asio events to actor methods
• [bugfix]rotor::ev::supervisor_ev_t properly handles refcounter

• Added libev support

• Initial version