Finalize actor documentation #1908
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
didier-wenzek
had a problem deploying
to
Test Pull Request
GitHub Actions
Failure
didier-wenzek
had a problem deploying
to
Test Pull Request
GitHub Actions
Failure
didier-wenzek
force-pushed
the
actors/finalize-doc
branch
from
9822fac
to
33813e9
Compare
didier-wenzek
had a problem deploying
to
Test Pull Request
GitHub Actions
Failure
didier-wenzek
temporarily deployed
to
Test Pull Request
GitHub Actions
Inactive
Robot Results
Passed Tests
|
rina23q
approved these changes
Apr 14, 2023
| } | ||
|
|
||
| pub struct Concurrent; | ||
| pub struct Sequential; |
There was a problem hiding this comment.
max_concurrency = 1 means sequential? Then, why do we need to have this?
There was a problem hiding this comment.
Yes, there is something to improve here.
| @@ -1,3 +1,59 @@ | |||
| //! Actors that convert each input message into a sequence of output messages | |||
There was a problem hiding this comment.
I didn't know the converter, now I know it! Looks so nice!!!
didier-wenzek
force-pushed
the
actors/finalize-doc
branch
from
382d2c1
to
cb327b8
Compare
didier-wenzek
temporarily deployed
to
Test Pull Request
GitHub Actions
Inactive
didier-wenzek
had a problem deploying
to
Test Pull Request
GitHub Actions
Failure
didier-wenzek
force-pushed
the
actors/finalize-doc
branch
from
39e99f2
to
02d2ac6
Compare
didier-wenzek
temporarily deployed
to
Test Pull Request
GitHub Actions
Inactive
albinsuresh
reviewed
Apr 28, 2023
| /// The builder of a MessageBox must implement this trait for every message type that can be sent to it | ||
| /// The [Builder] of an [Actor](crate::Actor) must implement this trait for every message type that can be sent to it | ||
| /// | ||
| /// A sink might be interested only by a subset of the messages emitted by the source. |
There was a problem hiding this comment.
Suggested change
| /// A sink might be interested only by a subset of the messages emitted by the source. | |
| /// A sink might be interested only in a subset of the messages emitted by the source. |
Comment on lines
189
to
190
| /// The builder of an [Actor](crate::Actor) must implement this trait | ||
| /// for every message type that it can receive from its peers |
There was a problem hiding this comment.
Suggested change
| /// The builder of an [Actor](crate::Actor) must implement this trait | |
| /// for every message type that it can receive from its peers | |
| /// The builder of an [Actor](crate::Actor) must implement this trait | |
| /// for every message type that it can emit to its peers. | |
| /// To receive messages from a `MessageSource<M, C>`, the peer must be a `MessageSink<M, C>` |
| @@ -153,13 +198,15 @@ pub trait MessageSource<M: Message, Config> { | |||
| } | |||
| } | |||
|
|
|||
| /// The builder of a MessageBox must implement this trait to receive requests from the runtime | |||
| /// The builder of an [Actor](crate::Actor) must implement this trait | |||
| /// to receive [runtime requests](crate::RuntimeRequest] from the [Runtime](crate::Runtime) | |||
There was a problem hiding this comment.
Suggested change
| /// to receive [runtime requests](crate::RuntimeRequest] from the [Runtime](crate::Runtime) | |
| /// to receive [runtime requests](crate::RuntimeRequest]s like shutdown requests from the [Runtime](crate::Runtime) |
Comment on lines
208
to
209
| /// A trait to connect an actor under-construction to peer actors | ||
| /// that use the service provided by this actor. |
There was a problem hiding this comment.
Suggested change
| /// A trait to connect an actor under-construction to peer actors | |
| /// that use the service provided by this actor. | |
| /// A trait that defines that an actor provides a service by accepting `Request` messages and sending `Response` from/to its peers. | |
| /// In order to connect to a to `ServiceProvider<Req, Res, Conf>` and avail its services, the peer must be a `ServiceConsumer<Req, Res, Conf>`. | |
| /// The config parameter is typically used by the `ServiceConsumer` to register any message filtering criteria to the `ServiceProvider`. |
There was a problem hiding this comment.
Applied the suggestion
| } | ||
| } | ||
|
|
||
| /// Build a message box ready to be used by the service actor |
There was a problem hiding this comment.
Suggested change
| /// Build a message box ready to be used by the service actor | |
| /// Build a message box ready to be used by the server actor |
Comment on lines
37
to
38
| /// Start to build a new message box for a service | ||
| pub fn new(service_name: &str, capacity: usize) -> Self { |
There was a problem hiding this comment.
Suggested change
| /// Start to build a new message box for a service | |
| pub fn new(service_name: &str, capacity: usize) -> Self { | |
| /// Start to build a new message box for the server actor | |
| pub fn new(server_name: &str, capacity: usize) -> Self { |
| } | ||
|
|
||
| /// Build a message box ready to be used by the service actor | ||
| fn build_service(self) -> ServerMessageBox<Request, Response> { |
There was a problem hiding this comment.
Suggested change
| fn build_service(self) -> ServerMessageBox<Request, Response> { | |
| fn build(self) -> ServerMessageBox<Request, Response> { |
There was a problem hiding this comment.
Renamed build_server to avoid confusion with the Builder::build() method also implemented by this struct.
didier-wenzek
had a problem deploying
to
Test Pull Request
GitHub Actions
Failure
didier-wenzek
had a problem deploying
to
Test Pull Request
GitHub Actions
Failure
didier-wenzek
had a problem deploying
to
Test Pull Request
GitHub Actions
Failure
albinsuresh
approved these changes
May 2, 2023
Comment on lines
114
to
115
| /// An actor which builder is a `MessageSink<M, C>` can be connected to any other actor | ||
| /// which builder is a `MessageSource<M, C>` so that the sink can receive messages from that source. |
There was a problem hiding this comment.
Suggested change
| /// An actor which builder is a `MessageSink<M, C>` can be connected to any other actor | |
| /// which builder is a `MessageSource<M, C>` so that the sink can receive messages from that source. | |
| /// An actor whose builder is a `MessageSink<M, C>` can be connected to any other actor | |
| /// whose builder is a `MessageSource<M, C>` so that the sink can receive messages from that source. |
ChatGPT confirmed that it is grammatically okay to use "whose" in this context ;)
crates/core/tedge_actors/src/lib.rs
Outdated
| //! | ||
| //! ``` | ||
| //! # use crate::tedge_actors::{Actor, RuntimeError, MessageReceiver, RuntimeRequest, Sender, SimpleMessageBox}; | ||
| //! # use async_trait::async_trait; | ||
| //! # | ||
| //! /// State of the calculator actor | ||
| //! /// State of the calculator actor along its message box |
There was a problem hiding this comment.
Suggested change
| //! /// State of the calculator actor along its message box | |
| //! /// State of the calculator actor along with its message box |
crates/core/tedge_actors/src/lib.rs
Outdated
| //! /// from where input messages are received | ||
| //! /// and to which output messages are sent. | ||
| //! /// | ||
| //! /// More sophisticated actors might used specific boxes, |
There was a problem hiding this comment.
Suggested change
| //! /// More sophisticated actors might used specific boxes, | |
| //! /// More sophisticated actors might use specific boxes, |
crates/core/tedge_actors/src/lib.rs
Outdated
| //! - Two actor builders, a `consumer: ServiceConsumer<I,O,C>` and a `producer: ServiceProvider<I,O,C>` | ||
| //! can then be connected to each other : `consumer.set_connection(producer)` | ||
| //! The connection builder traits work by pairs: | ||
| //! - A [MessageSink](crate::MessageSink) connects a [MessageSource](crate::MessageSource), |
There was a problem hiding this comment.
Suggested change
| //! - A [MessageSink](crate::MessageSink) connects a [MessageSource](crate::MessageSource), | |
| //! - A [MessageSink](crate::MessageSink) connects to a [MessageSource](crate::MessageSource), |
| //! The connection builder traits work by pairs: | ||
| //! - A [MessageSink](crate::MessageSink) connects a [MessageSource](crate::MessageSource), | ||
| //! so the messages sent by the latter will be received by the former. | ||
| //! - A [ServiceConsumer](crate::ServiceConsumer) connects a [ServiceProvider](crate::ServiceProvider), |
There was a problem hiding this comment.
Suggested change
| //! - A [ServiceConsumer](crate::ServiceConsumer) connects a [ServiceProvider](crate::ServiceProvider), | |
| //! - A [ServiceConsumer](crate::ServiceConsumer) connects to a [ServiceProvider](crate::ServiceProvider), |
crates/core/tedge_actors/src/lib.rs
Outdated
| //! impl ServiceProvider<SomeInput,SomeOutput,SomeConfig> for SomeActorBuilder { | ||
| //! /// Exchange two message senders with the new peer, so each can send messages to the other | ||
| //! /// | ||
| //! /// The service registers the new consumer and ist sender (i.e. where to send response), |
There was a problem hiding this comment.
Suggested change
| //! /// The service registers the new consumer and ist sender (i.e. where to send response), | |
| //! /// The service registers the new consumer and its sender (i.e. where to send response), |
crates/core/tedge_actors/src/lib.rs
Outdated
| //! - Any actor can send [RuntimeAction] to the runtime, | ||
| //! to spawn a new actor or to request a global shutdown of the application. | ||
| //! - An actor can subscribe to the [RuntimeEvent] published by the runtime, | ||
| //! to be notified of actor events as start, termination or crash. |
There was a problem hiding this comment.
Suggested change
| //! to be notified of actor events as start, termination or crash. | |
| //! to be notified of actor events such as start, termination or crash. |
crates/core/tedge_actors/src/lib.rs
Outdated
| //! | ||
| //! To run an actor `A` using the [tedge_actors::Runtime](crate::Runtime) requires more than just | ||
| //! an [Actor] implementation. One needs an [actor builder](crate::builders) that implements: | ||
| //! - `Builder<A>` to let the runtime creates the actor instance, |
There was a problem hiding this comment.
Suggested change
| //! - `Builder<A>` to let the runtime creates the actor instance, | |
| //! - `Builder<A>` to let the runtime create the actor instance, |
Signed-off-by: Didier Wenzek <didier.wenzek@free.fr>
Signed-off-by: Didier Wenzek <didier.wenzek@free.fr>
Signed-off-by: Didier Wenzek <didier.wenzek@free.fr>
Signed-off-by: Didier Wenzek <didier.wenzek@free.fr>
The Calculator can no more implement the Actor and Server traits as the former expects the message box to be owned by the actor while the latter wraps the server with an external message box. Signed-off-by: Didier Wenzek <didier.wenzek@free.fr>
Signed-off-by: Didier Wenzek <didier.wenzek@free.fr>
Signed-off-by: Didier Wenzek <didier.wenzek@free.fr>
didier-wenzek
force-pushed
the
actors/finalize-doc
branch
from
3652e5c
to
4c73c2b
Compare
didier-wenzek
had a problem deploying
to
Test Pull Request
GitHub Actions
Failure
didier-wenzek
temporarily deployed
to
Test Pull Request
GitHub Actions
Inactive
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Types of changes
Paste Link to the issue
Checklist
cargo fmtas mentioned in CODING_GUIDELINEScargo clippyas mentioned in CODING_GUIDELINESFurther comments