Commit 6efb587a authored by Dominik Charousset's avatar Dominik Charousset

Fix documentation warnings

parent f4f5ed4d
...@@ -85,7 +85,7 @@ public: ...@@ -85,7 +85,7 @@ public:
/// Emits a `stream_msg::ack_batch` on this path and sets `assigned_credit` /// Emits a `stream_msg::ack_batch` on this path and sets `assigned_credit`
/// to `initial_demand`. /// to `initial_demand`.
void emit_ack_open(actor_addr rebind_from, long initial_demand, void emit_ack_open(actor_addr rebind_from, long initial_demand,
bool redeployable); bool is_redeployable);
void emit_ack_batch(long new_demand); void emit_ack_batch(long new_demand);
......
...@@ -101,7 +101,7 @@ public: ...@@ -101,7 +101,7 @@ public:
void emit_open(strong_actor_ptr origin, void emit_open(strong_actor_ptr origin,
mailbox_element::forwarding_stack stages, message_id mid, mailbox_element::forwarding_stack stages, message_id mid,
message handshake_data, stream_priority prio, message handshake_data, stream_priority prio,
bool redeployable); bool is_redeployable);
/// Emits a `stream_msg::batch` on this path, decrements `open_credit` by /// Emits a `stream_msg::batch` on this path, decrements `open_credit` by
/// `xs_size` and increments `next_batch_id` by 1. /// `xs_size` and increments `next_batch_id` by 1.
......
...@@ -561,7 +561,7 @@ public: ...@@ -561,7 +561,7 @@ public:
/// @param init Function object for initializing the state of the stage. /// @param init Function object for initializing the state of the stage.
/// @param fun Function object for processing stream elements. /// @param fun Function object for processing stream elements.
/// @param finalize Function object for producing the final result. /// @param finalize Function object for producing the final result.
/// @param gatherer_type Sets the policy for upstream communication. /// @param policies Sets the policies for up- and downstream communication.
/// @returns A stream object with a pointer to the generated `stream_manager`. /// @returns A stream object with a pointer to the generated `stream_manager`.
template <class In, class Init, class Fun, class Finalize, template <class In, class Init, class Fun, class Finalize,
class Gatherer = random_gatherer, class Gatherer = random_gatherer,
...@@ -681,10 +681,13 @@ public: ...@@ -681,10 +681,13 @@ public:
/// Tries to add a new sink to the stream manager `mgr`. /// Tries to add a new sink to the stream manager `mgr`.
/// @param mgr Pointer to the responsible stream manager. /// @param mgr Pointer to the responsible stream manager.
/// @param sid The ID used for communicating to the sink. /// @param sid The ID used for communicating to the sink.
/// @param origin Handle to the actor that initiated the stream and that will
/// receive the stream result (if any).
/// @param sink_ptr Handle to the new sink. /// @param sink_ptr Handle to the new sink.
/// @param fwd_stack Forwarding stack for the remaining stream participants.
/// @param prio Priority of the traffic to the sink. /// @param prio Priority of the traffic to the sink.
/// @param delegate_handshake Configures whether the current message ID is /// @param handshake_mid Message ID for the stream handshake. If valid, this
/// forwarded to the sink. /// ID will be used to send the result to the `origin`.
/// @param data Additional payload for the stream handshake. /// @param data Additional payload for the stream handshake.
/// @returns `true` if the sink could be added to the manager, `false` /// @returns `true` if the sink could be added to the manager, `false`
/// otherwise. /// otherwise.
......
...@@ -52,11 +52,14 @@ public: ...@@ -52,11 +52,14 @@ public:
strong_actor_ptr original_stage, stream_priority priority, strong_actor_ptr original_stage, stream_priority priority,
bool redeployable, response_promise result_cb); bool redeployable, response_promise result_cb);
/// Handles `stream_msg::ack_open` messages. /// Handles `stream_msg::ack_open` messages, i.e., finalizes the stream
/// @param hdl Handle to the sender. /// handshake.
/// @param initial_demand Credit received with `ack_open`. /// @param sid ID of the outgoing stream.
/// @param rebind_from Receiver of the original `open` message.
/// @param rebind_to Sender of this confirmation.
/// @param initial_demand Credit received with this `ack_open`.
/// @param redeployable Denotes whether the runtime can redeploy /// @param redeployable Denotes whether the runtime can redeploy
/// the downstream actor on failure. /// `rebind_to` on failure.
/// @pre `hdl != nullptr` /// @pre `hdl != nullptr`
virtual error ack_open(const stream_id& sid, const actor_addr& rebind_from, virtual error ack_open(const stream_id& sid, const actor_addr& rebind_from,
strong_actor_ptr rebind_to, long initial_demand, strong_actor_ptr rebind_to, long initial_demand,
...@@ -159,7 +162,6 @@ protected: ...@@ -159,7 +162,6 @@ protected:
/// Called when the gatherer closes to produce the final stream result for /// Called when the gatherer closes to produce the final stream result for
/// all listeners. The default implementation returns an empty message. /// all listeners. The default implementation returns an empty message.
/// @param reason `none` on orderly shutdowns, otherwise the abort reason.
virtual message make_final_result(); virtual message make_final_result();
/// Called to handle incoming data. The default implementation logs an error /// Called to handle incoming data. The default implementation logs an error
......
...@@ -63,7 +63,7 @@ public: ...@@ -63,7 +63,7 @@ public:
if (capacity <= 0) if (capacity <= 0)
return false; return false;
downstream<typename DownstreamPolicy::value_type> ds{out_.buf()}; downstream<typename DownstreamPolicy::value_type> ds{out_.buf()};
fun_(state_, ds, capacity); fun_(state_, ds, static_cast<size_t>(capacity));
return true; return true;
} }
......
...@@ -56,14 +56,15 @@ void inbound_path::handle_batch(long batch_size, int64_t batch_id) { ...@@ -56,14 +56,15 @@ void inbound_path::handle_batch(long batch_size, int64_t batch_id) {
} }
void inbound_path::emit_ack_open(actor_addr rebind_from, void inbound_path::emit_ack_open(actor_addr rebind_from,
long initial_demand, bool redeployable) { long initial_demand, bool is_redeployable) {
CAF_LOG_TRACE(CAF_ARG(rebind_from) << CAF_ARG(initial_demand) CAF_LOG_TRACE(CAF_ARG(rebind_from) << CAF_ARG(initial_demand)
<< CAF_ARG(redeployable)); << CAF_ARG(is_redeployable));
assigned_credit = initial_demand; assigned_credit = initial_demand;
redeployable = is_redeployable;
unsafe_send_as(self, hdl, unsafe_send_as(self, hdl,
make<stream_msg::ack_open>( make<stream_msg::ack_open>(
sid, self->address(), std::move(rebind_from), self->ctrl(), sid, self->address(), std::move(rebind_from), self->ctrl(),
static_cast<int32_t>(initial_demand), redeployable)); static_cast<int32_t>(initial_demand), is_redeployable));
} }
void inbound_path::emit_ack_batch(long new_demand) { void inbound_path::emit_ack_batch(long new_demand) {
......
...@@ -61,16 +61,17 @@ void outbound_path::handle_ack_open(long initial_credit) { ...@@ -61,16 +61,17 @@ void outbound_path::handle_ack_open(long initial_credit) {
void outbound_path::emit_open(strong_actor_ptr origin, void outbound_path::emit_open(strong_actor_ptr origin,
mailbox_element::forwarding_stack stages, mailbox_element::forwarding_stack stages,
message_id handshake_mid, message handshake_data, message_id handshake_mid, message handshake_data,
stream_priority prio, bool redeployable) { stream_priority prio, bool is_redeployable) {
CAF_LOG_TRACE(CAF_ARG(origin) << CAF_ARG(stages) << CAF_ARG(handshake_mid) CAF_LOG_TRACE(CAF_ARG(origin) << CAF_ARG(stages) << CAF_ARG(handshake_mid)
<< CAF_ARG(handshake_data) << CAF_ARG(prio) << CAF_ARG(handshake_data) << CAF_ARG(prio)
<< CAF_ARG(redeployable)); << CAF_ARG(is_redeployable));
cd = client_data{origin, handshake_mid}; cd = client_data{origin, handshake_mid};
redeployable = is_redeployable;
hdl->enqueue( hdl->enqueue(
make_mailbox_element(std::move(origin), handshake_mid, std::move(stages), make_mailbox_element(std::move(origin), handshake_mid, std::move(stages),
make_message(make<stream_msg::open>( make_message(make<stream_msg::open>(
sid, self->address(), std::move(handshake_data), sid, self->address(), std::move(handshake_data),
self->ctrl(), hdl, prio, redeployable))), self->ctrl(), hdl, prio, is_redeployable))),
self->context()); self->context());
} }
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment