flwr-nightly 1.19.0.dev20250429__py3-none-any.whl → 1.19.0.dev20250430__py3-none-any.whl

flwr/client/grpc_rere_client/connection.py

@@ -15,8 +15,6 @@
 """Contextmanager for a gRPC request-response channel to the Flower server."""
 
 
-import random
-import threading
 from collections.abc import Iterator, Sequence
 from contextlib import contextmanager
 from copy import copy
@@ -27,16 +25,11 @@ from typing import Callable, Optional, Union, cast
 import grpc
 from cryptography.hazmat.primitives.asymmetric import ec
 
-from flwr.client.heartbeat import start_ping_loop
 from flwr.client.message_handler.message_handler import validate_out_message
 from flwr.common import GRPC_MAX_MESSAGE_LENGTH
-from flwr.common.constant import (
-    PING_BASE_MULTIPLIER,
-    PING_CALL_TIMEOUT,
-    PING_DEFAULT_INTERVAL,
-    PING_RANDOM_RANGE,
-)
+from flwr.common.constant import HEARTBEAT_CALL_TIMEOUT, HEARTBEAT_DEFAULT_INTERVAL
 from flwr.common.grpc import create_channel, on_channel_state_change
+from flwr.common.heartbeat import HeartbeatSender
 from flwr.common.logger import log
 from flwr.common.message import Message, Metadata
 from flwr.common.retry_invoker import RetryInvoker
@@ -49,8 +42,8 @@ from flwr.proto.fab_pb2 import GetFabRequest, GetFabResponse  # pylint: disable=
 from flwr.proto.fleet_pb2 import (  # pylint: disable=E0611
     CreateNodeRequest,
     DeleteNodeRequest,
-    PingRequest,
-    PingResponse,
+    HeartbeatRequest,
+    HeartbeatResponse,
     PullMessagesRequest,
     PullMessagesResponse,
     PushMessagesRequest,
@@ -151,8 +144,6 @@ def grpc_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
     stub = adapter_cls(channel)
     metadata: Optional[Metadata] = None
     node: Optional[Node] = None
-    ping_thread: Optional[threading.Thread] = None
-    ping_stop_event = threading.Event()
 
     def _should_giveup_fn(e: Exception) -> bool:
         if e.code() == grpc.StatusCode.PERMISSION_DENIED:  # type: ignore
@@ -166,45 +157,54 @@ def grpc_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
     retry_invoker.should_giveup = _should_giveup_fn
 
     ###########################################################################
-    # ping/create_node/delete_node/receive/send/get_run functions
+    # heartbeat/create_node/delete_node/receive/send/get_run functions
     ###########################################################################
 
-    def ping() -> None:
+    def heartbeat() -> bool:
         # Get Node
         if node is None:
             log(ERROR, "Node instance missing")
-            return
+            return False
 
-        # Construct the ping request
-        req = PingRequest(node=node, ping_interval=PING_DEFAULT_INTERVAL)
+        # Construct the heartbeat request
+        req = HeartbeatRequest(node=node, heartbeat_interval=HEARTBEAT_DEFAULT_INTERVAL)
 
         # Call FleetAPI
-        res: PingResponse = stub.Ping(req, timeout=PING_CALL_TIMEOUT)
+        try:
+            res: HeartbeatResponse = stub.Heartbeat(req, timeout=HEARTBEAT_CALL_TIMEOUT)
+        except grpc.RpcError as e:
+            status_code = e.code()
+            if status_code == grpc.StatusCode.UNAVAILABLE:
+                return False
+            if status_code == grpc.StatusCode.DEADLINE_EXCEEDED:
+                return False
+            raise
 
         # Check if success
         if not res.success:
-            raise RuntimeError("Ping failed unexpectedly.")
+            raise RuntimeError(
+                "Heartbeat failed unexpectedly. The SuperLink does not "
+                "recognize this SuperNode."
+            )
+        return True
 
-        # Wait
-        rd = random.uniform(*PING_RANDOM_RANGE)
-        next_interval: float = PING_DEFAULT_INTERVAL - PING_CALL_TIMEOUT
-        next_interval *= PING_BASE_MULTIPLIER + rd
-        if not ping_stop_event.is_set():
-            ping_stop_event.wait(next_interval)
+    heartbeat_sender = HeartbeatSender(heartbeat)
 
     def create_node() -> Optional[int]:
         """Set create_node."""
         # Call FleetAPI
-        create_node_request = CreateNodeRequest(ping_interval=PING_DEFAULT_INTERVAL)
+        create_node_request = CreateNodeRequest(
+            heartbeat_interval=HEARTBEAT_DEFAULT_INTERVAL
+        )
         create_node_response = retry_invoker.invoke(
             stub.CreateNode,
             request=create_node_request,
         )
 
-        # Remember the node and the ping-loop thread
-        nonlocal node, ping_thread
+        # Remember the node and start the heartbeat sender
+        nonlocal node
         node = cast(Node, create_node_response.node)
-        ping_thread = start_ping_loop(ping, ping_stop_event)
+        heartbeat_sender.start()
         return node.node_id
 
     def delete_node() -> None:
@@ -215,8 +215,8 @@ def grpc_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
             log(ERROR, "Node instance missing")
             return
 
-        # Stop the ping-loop thread
-        ping_stop_event.set()
+        # Stop the heartbeat sender
+        heartbeat_sender.stop()
 
         # Call FleetAPI
         delete_node_request = DeleteNodeRequest(node=node)

flwr/client/grpc_rere_client/grpc_adapter.py

@@ -38,8 +38,8 @@ from flwr.proto.fleet_pb2 import (  # pylint: disable=E0611
     CreateNodeResponse,
     DeleteNodeRequest,
     DeleteNodeResponse,
-    PingRequest,
-    PingResponse,
+    HeartbeatRequest,
+    HeartbeatResponse,
     PullMessagesRequest,
     PullMessagesResponse,
     PushMessagesRequest,
@@ -120,11 +120,11 @@ class GrpcAdapter:
         """."""
         return self._send_and_receive(request, DeleteNodeResponse, **kwargs)
 
-    def Ping(  # pylint: disable=C0103
-        self, request: PingRequest, **kwargs: Any
-    ) -> PingResponse:
+    def Heartbeat(  # pylint: disable=C0103
+        self, request: HeartbeatRequest, **kwargs: Any
+    ) -> HeartbeatResponse:
         """."""
-        return self._send_and_receive(request, PingResponse, **kwargs)
+        return self._send_and_receive(request, HeartbeatResponse, **kwargs)
 
     def PullMessages(  # pylint: disable=C0103
         self, request: PullMessagesRequest, **kwargs: Any

flwr/client/rest_client/connection.py

@@ -15,8 +15,6 @@
 """Contextmanager for a REST request-response channel to the Flower server."""
 
 
-import random
-import threading
 from collections.abc import Iterator
 from contextlib import contextmanager
 from copy import copy
@@ -27,16 +25,11 @@ from cryptography.hazmat.primitives.asymmetric import ec
 from google.protobuf.message import Message as GrpcMessage
 from requests.exceptions import ConnectionError as RequestsConnectionError
 
-from flwr.client.heartbeat import start_ping_loop
 from flwr.client.message_handler.message_handler import validate_out_message
 from flwr.common import GRPC_MAX_MESSAGE_LENGTH
-from flwr.common.constant import (
-    PING_BASE_MULTIPLIER,
-    PING_CALL_TIMEOUT,
-    PING_DEFAULT_INTERVAL,
-    PING_RANDOM_RANGE,
-)
+from flwr.common.constant import HEARTBEAT_DEFAULT_INTERVAL
 from flwr.common.exit import ExitCode, flwr_exit
+from flwr.common.heartbeat import HeartbeatSender
 from flwr.common.logger import log
 from flwr.common.message import Message, Metadata
 from flwr.common.retry_invoker import RetryInvoker
@@ -48,8 +41,8 @@ from flwr.proto.fleet_pb2 import (  # pylint: disable=E0611
     CreateNodeResponse,
     DeleteNodeRequest,
     DeleteNodeResponse,
-    PingRequest,
-    PingResponse,
+    HeartbeatRequest,
+    HeartbeatResponse,
     PullMessagesRequest,
     PullMessagesResponse,
     PushMessagesRequest,
@@ -68,7 +61,7 @@ PATH_CREATE_NODE: str = "api/v0/fleet/create-node"
 PATH_DELETE_NODE: str = "api/v0/fleet/delete-node"
 PATH_PULL_MESSAGES: str = "/api/v0/fleet/pull-messages"
 PATH_PUSH_MESSAGES: str = "/api/v0/fleet/push-messages"
-PATH_PING: str = "api/v0/fleet/ping"
+PATH_PING: str = "api/v0/fleet/heartbeat"
 PATH_GET_RUN: str = "/api/v0/fleet/get-run"
 PATH_GET_FAB: str = "/api/v0/fleet/get-fab"
 
@@ -160,11 +153,9 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
     # Shared variables for inner functions
     metadata: Optional[Metadata] = None
     node: Optional[Node] = None
-    ping_thread: Optional[threading.Thread] = None
-    ping_stop_event = threading.Event()
 
     ###########################################################################
-    # ping/create_node/delete_node/receive/send/get_run functions
+    # heartbeat/create_node/delete_node/receive/send/get_run functions
     ###########################################################################
 
     def _request(
@@ -214,44 +205,43 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
         grpc_res.ParseFromString(res.content)
         return grpc_res
 
-    def ping() -> None:
+    def heartbeat() -> bool:
         # Get Node
         if node is None:
             log(ERROR, "Node instance missing")
-            return
+            return False
 
-        # Construct the ping request
-        req = PingRequest(node=node, ping_interval=PING_DEFAULT_INTERVAL)
+        # Construct the heartbeat request
+        req = HeartbeatRequest(node=node, heartbeat_interval=HEARTBEAT_DEFAULT_INTERVAL)
 
         # Send the request
-        res = _request(req, PingResponse, PATH_PING, retry=False)
+        res = _request(req, HeartbeatResponse, PATH_PING, retry=False)
         if res is None:
-            return
+            return False
 
         # Check if success
         if not res.success:
-            raise RuntimeError("Ping failed unexpectedly.")
+            raise RuntimeError(
+                "Heartbeat failed unexpectedly. The SuperLink does not "
+                "recognize this SuperNode."
+            )
+        return True
 
-        # Wait
-        rd = random.uniform(*PING_RANDOM_RANGE)
-        next_interval: float = PING_DEFAULT_INTERVAL - PING_CALL_TIMEOUT
-        next_interval *= PING_BASE_MULTIPLIER + rd
-        if not ping_stop_event.is_set():
-            ping_stop_event.wait(next_interval)
+    heartbeat_sender = HeartbeatSender(heartbeat)
 
     def create_node() -> Optional[int]:
         """Set create_node."""
-        req = CreateNodeRequest(ping_interval=PING_DEFAULT_INTERVAL)
+        req = CreateNodeRequest(heartbeat_interval=HEARTBEAT_DEFAULT_INTERVAL)
 
         # Send the request
         res = _request(req, CreateNodeResponse, PATH_CREATE_NODE)
         if res is None:
             return None
 
-        # Remember the node and the ping-loop thread
-        nonlocal node, ping_thread
+        # Remember the node and start the heartbeat sender
+        nonlocal node
         node = res.node
-        ping_thread = start_ping_loop(ping, ping_stop_event)
+        heartbeat_sender.start()
         return node.node_id
 
     def delete_node() -> None:
@@ -261,10 +251,8 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
             log(ERROR, "Node instance missing")
             return
 
-        # Stop the ping-loop thread
-        ping_stop_event.set()
-        if ping_thread is not None:
-            ping_thread.join()
+        # Stop the heartbeat sender
+        heartbeat_sender.stop()
 
         # Send DeleteNode request
         req = DeleteNodeRequest(node=node)

flwr/common/constant.py

@@ -55,13 +55,13 @@ EXEC_API_DEFAULT_SERVER_ADDRESS = f"{SERVER_OCTET}:{EXEC_API_PORT}"
 SIMULATIONIO_API_DEFAULT_SERVER_ADDRESS = f"{SERVER_OCTET}:{SIMULATIONIO_PORT}"
 SIMULATIONIO_API_DEFAULT_CLIENT_ADDRESS = f"{CLIENT_OCTET}:{SIMULATIONIO_PORT}"
 
-# Constants for ping
-PING_DEFAULT_INTERVAL = 30
-PING_CALL_TIMEOUT = 5
-PING_BASE_MULTIPLIER = 0.8
-PING_RANDOM_RANGE = (-0.1, 0.1)
-PING_MAX_INTERVAL = 1e300
-PING_PATIENCE = 2
+# Constants for heartbeat
+HEARTBEAT_DEFAULT_INTERVAL = 30
+HEARTBEAT_CALL_TIMEOUT = 5
+HEARTBEAT_BASE_MULTIPLIER = 0.8
+HEARTBEAT_RANDOM_RANGE = (-0.1, 0.1)
+HEARTBEAT_MAX_INTERVAL = 1e300
+HEARTBEAT_PATIENCE = 2
 
 # IDs
 RUN_ID_NUM_BYTES = 8
@@ -121,6 +121,9 @@ TIMESTAMP_HEADER = "flwr-timestamp"
 TIMESTAMP_TOLERANCE = 10  # General tolerance for timestamp verification
 SYSTEM_TIME_TOLERANCE = 5  # Allowance for system time drift
 
+# Constants for grpc retry
+GRPC_RETRY_MAX_DELAY = 20  # Maximum delay duration between two consecutive retries.
+
 # Constants for ArrayRecord
 GC_THRESHOLD = 200_000_000  # 200 MB
 

flwr/common/heartbeat.py

@@ -0,0 +1,103 @@
+# Copyright 2025 Flower Labs GmbH. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
+"""Heartbeat sender."""
+
+
+import random
+import threading
+from typing import Callable
+
+from .constant import (
+    HEARTBEAT_BASE_MULTIPLIER,
+    HEARTBEAT_CALL_TIMEOUT,
+    HEARTBEAT_DEFAULT_INTERVAL,
+    HEARTBEAT_RANDOM_RANGE,
+)
+from .retry_invoker import RetryInvoker, exponential
+
+
+class HeartbeatFailure(Exception):
+    """Exception raised when a heartbeat fails."""
+
+
+class HeartbeatSender:
+    """Periodically send heartbeat signals to a server in a background thread.
+
+    This class uses the provided `heartbeat_fn` to send heartbeats. If a heartbeat
+    attempt fails, it will be retried using an exponential backoff strategy.
+
+    Parameters
+    ----------
+    heartbeat_fn : Callable[[], bool]
+        Function used to send a heartbeat signal. It should return True if the heartbeat
+        succeeds, or False if it fails. Any internal exceptions (e.g., gRPC errors)
+        should be handled within this function to ensure boolean return values.
+    """
+
+    def __init__(
+        self,
+        heartbeat_fn: Callable[[], bool],
+    ) -> None:
+        self.heartbeat_fn = heartbeat_fn
+        self._stop_event = threading.Event()
+        self._thread = threading.Thread(target=self._run, daemon=True)
+        self._retry_invoker = RetryInvoker(
+            lambda: exponential(max_delay=20),
+            HeartbeatFailure,  # The only exception we want to retry on
+            max_tries=None,
+            max_time=None,
+            # Allow the stop event to interrupt the wait
+            wait_function=self._stop_event.wait,  # type: ignore
+        )
+
+    def start(self) -> None:
+        """Start the heartbeat sender."""
+        if self._thread.is_alive():
+            raise RuntimeError("Heartbeat sender is already running.")
+        if self._stop_event.is_set():
+            raise RuntimeError("Cannot start a stopped heartbeat sender.")
+        self._thread.start()
+
+    def stop(self) -> None:
+        """Stop the heartbeat sender."""
+        if not self._thread.is_alive():
+            raise RuntimeError("Heartbeat sender is not running.")
+        self._stop_event.set()
+        self._thread.join()
+
+    def _run(self) -> None:
+        """Periodically send heartbeats until stopped."""
+        while not self._stop_event.is_set():
+            # Attempt to send a heartbeat with retry on failure
+            self._retry_invoker.invoke(self._heartbeat)
+
+            # Calculate the interval for the next heartbeat
+            # Formula: next_interval = (interval - timeout) * random.uniform(0.7, 0.9)
+            rd = random.uniform(*HEARTBEAT_RANDOM_RANGE)
+            next_interval: float = HEARTBEAT_DEFAULT_INTERVAL - HEARTBEAT_CALL_TIMEOUT
+            next_interval *= HEARTBEAT_BASE_MULTIPLIER + rd
+
+            # Wait for the calculated interval or exit early if stopped
+            self._stop_event.wait(next_interval)
+
+    def _heartbeat(self) -> None:
+        """Send a single heartbeat and raise an exception if it fails.
+
+        Call the provided `heartbeat_fn`. If the function returns False,
+        a `HeartbeatFailure` exception is raised to trigger the retry mechanism.
+        """
+        if not self._stop_event.is_set():
+            if not self.heartbeat_fn():
+                raise HeartbeatFailure

flwr/proto/fleet_pb2.py

@@ -18,7 +18,7 @@ from flwr.proto import fab_pb2 as flwr_dot_proto_dot_fab__pb2
 from flwr.proto import message_pb2 as flwr_dot_proto_dot_message__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x16\x66lwr/proto/fleet.proto\x12\nflwr.proto\x1a\x15\x66lwr/proto/node.proto\x1a\x14\x66lwr/proto/run.proto\x1a\x14\x66lwr/proto/fab.proto\x1a\x18\x66lwr/proto/message.proto\"*\n\x11\x43reateNodeRequest\x12\x15\n\rping_interval\x18\x01 \x01(\x01\"4\n\x12\x43reateNodeResponse\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\"3\n\x11\x44\x65leteNodeRequest\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\"\x14\n\x12\x44\x65leteNodeResponse\"D\n\x0bPingRequest\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\x12\x15\n\rping_interval\x18\x02 \x01(\x01\"\x1f\n\x0cPingResponse\x12\x0f\n\x07success\x18\x01 \x01(\x08\"J\n\x13PullMessagesRequest\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\x12\x13\n\x0bmessage_ids\x18\x02 \x03(\t\"l\n\x14PullMessagesResponse\x12(\n\treconnect\x18\x01 \x01(\x0b\x32\x15.flwr.proto.Reconnect\x12*\n\rmessages_list\x18\x02 \x03(\x0b\x32\x13.flwr.proto.Message\"a\n\x13PushMessagesRequest\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\x12*\n\rmessages_list\x18\x02 \x03(\x0b\x32\x13.flwr.proto.Message\"\xb0\x01\n\x14PushMessagesResponse\x12(\n\treconnect\x18\x01 \x01(\x0b\x32\x15.flwr.proto.Reconnect\x12>\n\x07results\x18\x02 \x03(\x0b\x32-.flwr.proto.PushMessagesResponse.ResultsEntry\x1a.\n\x0cResultsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\r:\x02\x38\x01\"\x1e\n\tReconnect\x12\x11\n\treconnect\x18\x01 \x01(\x04\x32\x92\x04\n\x05\x46leet\x12M\n\nCreateNode\x12\x1d.flwr.proto.CreateNodeRequest\x1a\x1e.flwr.proto.CreateNodeResponse\"\x00\x12M\n\nDeleteNode\x12\x1d.flwr.proto.DeleteNodeRequest\x1a\x1e.flwr.proto.DeleteNodeResponse\"\x00\x12;\n\x04Ping\x12\x17.flwr.proto.PingRequest\x1a\x18.flwr.proto.PingResponse\"\x00\x12S\n\x0cPullMessages\x12\x1f.flwr.proto.PullMessagesRequest\x1a .flwr.proto.PullMessagesResponse\"\x00\x12S\n\x0cPushMessages\x12\x1f.flwr.proto.PushMessagesRequest\x1a .flwr.proto.PushMessagesResponse\"\x00\x12\x41\n\x06GetRun\x12\x19.flwr.proto.GetRunRequest\x1a\x1a.flwr.proto.GetRunResponse\"\x00\x12\x41\n\x06GetFab\x12\x19.flwr.proto.GetFabRequest\x1a\x1a.flwr.proto.GetFabResponse\"\x00\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x16\x66lwr/proto/fleet.proto\x12\nflwr.proto\x1a\x15\x66lwr/proto/node.proto\x1a\x14\x66lwr/proto/run.proto\x1a\x14\x66lwr/proto/fab.proto\x1a\x18\x66lwr/proto/message.proto\"/\n\x11\x43reateNodeRequest\x12\x1a\n\x12heartbeat_interval\x18\x01 \x01(\x01\"4\n\x12\x43reateNodeResponse\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\"3\n\x11\x44\x65leteNodeRequest\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\"\x14\n\x12\x44\x65leteNodeResponse\"N\n\x10HeartbeatRequest\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\x12\x1a\n\x12heartbeat_interval\x18\x02 \x01(\x01\"$\n\x11HeartbeatResponse\x12\x0f\n\x07success\x18\x01 \x01(\x08\"J\n\x13PullMessagesRequest\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\x12\x13\n\x0bmessage_ids\x18\x02 \x03(\t\"l\n\x14PullMessagesResponse\x12(\n\treconnect\x18\x01 \x01(\x0b\x32\x15.flwr.proto.Reconnect\x12*\n\rmessages_list\x18\x02 \x03(\x0b\x32\x13.flwr.proto.Message\"a\n\x13PushMessagesRequest\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\x12*\n\rmessages_list\x18\x02 \x03(\x0b\x32\x13.flwr.proto.Message\"\xb0\x01\n\x14PushMessagesResponse\x12(\n\treconnect\x18\x01 \x01(\x0b\x32\x15.flwr.proto.Reconnect\x12>\n\x07results\x18\x02 \x03(\x0b\x32-.flwr.proto.PushMessagesResponse.ResultsEntry\x1a.\n\x0cResultsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\r:\x02\x38\x01\"\x1e\n\tReconnect\x12\x11\n\treconnect\x18\x01 \x01(\x04\x32\xa1\x04\n\x05\x46leet\x12M\n\nCreateNode\x12\x1d.flwr.proto.CreateNodeRequest\x1a\x1e.flwr.proto.CreateNodeResponse\"\x00\x12M\n\nDeleteNode\x12\x1d.flwr.proto.DeleteNodeRequest\x1a\x1e.flwr.proto.DeleteNodeResponse\"\x00\x12J\n\tHeartbeat\x12\x1c.flwr.proto.HeartbeatRequest\x1a\x1d.flwr.proto.HeartbeatResponse\"\x00\x12S\n\x0cPullMessages\x12\x1f.flwr.proto.PullMessagesRequest\x1a .flwr.proto.PullMessagesResponse\"\x00\x12S\n\x0cPushMessages\x12\x1f.flwr.proto.PushMessagesRequest\x1a .flwr.proto.PushMessagesResponse\"\x00\x12\x41\n\x06GetRun\x12\x19.flwr.proto.GetRunRequest\x1a\x1a.flwr.proto.GetRunResponse\"\x00\x12\x41\n\x06GetFab\x12\x19.flwr.proto.GetFabRequest\x1a\x1a.flwr.proto.GetFabResponse\"\x00\x62\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -28,29 +28,29 @@ if _descriptor._USE_C_DESCRIPTORS == False:
   _globals['_PUSHMESSAGESRESPONSE_RESULTSENTRY']._options = None
   _globals['_PUSHMESSAGESRESPONSE_RESULTSENTRY']._serialized_options = b'8\001'
   _globals['_CREATENODEREQUEST']._serialized_start=131
-  _globals['_CREATENODEREQUEST']._serialized_end=173
-  _globals['_CREATENODERESPONSE']._serialized_start=175
-  _globals['_CREATENODERESPONSE']._serialized_end=227
-  _globals['_DELETENODEREQUEST']._serialized_start=229
-  _globals['_DELETENODEREQUEST']._serialized_end=280
-  _globals['_DELETENODERESPONSE']._serialized_start=282
-  _globals['_DELETENODERESPONSE']._serialized_end=302
-  _globals['_PINGREQUEST']._serialized_start=304
-  _globals['_PINGREQUEST']._serialized_end=372
-  _globals['_PINGRESPONSE']._serialized_start=374
-  _globals['_PINGRESPONSE']._serialized_end=405
-  _globals['_PULLMESSAGESREQUEST']._serialized_start=407
-  _globals['_PULLMESSAGESREQUEST']._serialized_end=481
-  _globals['_PULLMESSAGESRESPONSE']._serialized_start=483
-  _globals['_PULLMESSAGESRESPONSE']._serialized_end=591
-  _globals['_PUSHMESSAGESREQUEST']._serialized_start=593
-  _globals['_PUSHMESSAGESREQUEST']._serialized_end=690
-  _globals['_PUSHMESSAGESRESPONSE']._serialized_start=693
-  _globals['_PUSHMESSAGESRESPONSE']._serialized_end=869
-  _globals['_PUSHMESSAGESRESPONSE_RESULTSENTRY']._serialized_start=823
-  _globals['_PUSHMESSAGESRESPONSE_RESULTSENTRY']._serialized_end=869
-  _globals['_RECONNECT']._serialized_start=871
-  _globals['_RECONNECT']._serialized_end=901
-  _globals['_FLEET']._serialized_start=904
-  _globals['_FLEET']._serialized_end=1434
+  _globals['_CREATENODEREQUEST']._serialized_end=178
+  _globals['_CREATENODERESPONSE']._serialized_start=180
+  _globals['_CREATENODERESPONSE']._serialized_end=232
+  _globals['_DELETENODEREQUEST']._serialized_start=234
+  _globals['_DELETENODEREQUEST']._serialized_end=285
+  _globals['_DELETENODERESPONSE']._serialized_start=287
+  _globals['_DELETENODERESPONSE']._serialized_end=307
+  _globals['_HEARTBEATREQUEST']._serialized_start=309
+  _globals['_HEARTBEATREQUEST']._serialized_end=387
+  _globals['_HEARTBEATRESPONSE']._serialized_start=389
+  _globals['_HEARTBEATRESPONSE']._serialized_end=425
+  _globals['_PULLMESSAGESREQUEST']._serialized_start=427
+  _globals['_PULLMESSAGESREQUEST']._serialized_end=501
+  _globals['_PULLMESSAGESRESPONSE']._serialized_start=503
+  _globals['_PULLMESSAGESRESPONSE']._serialized_end=611
+  _globals['_PUSHMESSAGESREQUEST']._serialized_start=613
+  _globals['_PUSHMESSAGESREQUEST']._serialized_end=710
+  _globals['_PUSHMESSAGESRESPONSE']._serialized_start=713
+  _globals['_PUSHMESSAGESRESPONSE']._serialized_end=889
+  _globals['_PUSHMESSAGESRESPONSE_RESULTSENTRY']._serialized_start=843
+  _globals['_PUSHMESSAGESRESPONSE_RESULTSENTRY']._serialized_end=889
+  _globals['_RECONNECT']._serialized_start=891
+  _globals['_RECONNECT']._serialized_end=921
+  _globals['_FLEET']._serialized_start=924
+  _globals['_FLEET']._serialized_end=1469
 # @@protoc_insertion_point(module_scope)

flwr/proto/fleet_pb2.pyi

@@ -16,13 +16,13 @@ DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
 class CreateNodeRequest(google.protobuf.message.Message):
     """CreateNode messages"""
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
-    PING_INTERVAL_FIELD_NUMBER: builtins.int
-    ping_interval: builtins.float
+    HEARTBEAT_INTERVAL_FIELD_NUMBER: builtins.int
+    heartbeat_interval: builtins.float
     def __init__(self,
         *,
-        ping_interval: builtins.float = ...,
+        heartbeat_interval: builtins.float = ...,
         ) -> None: ...
-    def ClearField(self, field_name: typing_extensions.Literal["ping_interval",b"ping_interval"]) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["heartbeat_interval",b"heartbeat_interval"]) -> None: ...
 global___CreateNodeRequest = CreateNodeRequest
 
 class CreateNodeResponse(google.protobuf.message.Message):
@@ -58,24 +58,24 @@ class DeleteNodeResponse(google.protobuf.message.Message):
         ) -> None: ...
 global___DeleteNodeResponse = DeleteNodeResponse
 
-class PingRequest(google.protobuf.message.Message):
-    """Ping messages"""
+class HeartbeatRequest(google.protobuf.message.Message):
+    """Heartbeat messages"""
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
     NODE_FIELD_NUMBER: builtins.int
-    PING_INTERVAL_FIELD_NUMBER: builtins.int
+    HEARTBEAT_INTERVAL_FIELD_NUMBER: builtins.int
     @property
     def node(self) -> flwr.proto.node_pb2.Node: ...
-    ping_interval: builtins.float
+    heartbeat_interval: builtins.float
     def __init__(self,
         *,
         node: typing.Optional[flwr.proto.node_pb2.Node] = ...,
-        ping_interval: builtins.float = ...,
+        heartbeat_interval: builtins.float = ...,
         ) -> None: ...
     def HasField(self, field_name: typing_extensions.Literal["node",b"node"]) -> builtins.bool: ...
-    def ClearField(self, field_name: typing_extensions.Literal["node",b"node","ping_interval",b"ping_interval"]) -> None: ...
-global___PingRequest = PingRequest
+    def ClearField(self, field_name: typing_extensions.Literal["heartbeat_interval",b"heartbeat_interval","node",b"node"]) -> None: ...
+global___HeartbeatRequest = HeartbeatRequest
 
-class PingResponse(google.protobuf.message.Message):
+class HeartbeatResponse(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
     SUCCESS_FIELD_NUMBER: builtins.int
     success: builtins.bool
@@ -84,7 +84,7 @@ class PingResponse(google.protobuf.message.Message):
         success: builtins.bool = ...,
         ) -> None: ...
     def ClearField(self, field_name: typing_extensions.Literal["success",b"success"]) -> None: ...
-global___PingResponse = PingResponse
+global___HeartbeatResponse = HeartbeatResponse
 
 class PullMessagesRequest(google.protobuf.message.Message):
     """PullMessages messages"""

flwr/proto/fleet_pb2_grpc.py

@@ -26,10 +26,10 @@ class FleetStub(object):
                 request_serializer=flwr_dot_proto_dot_fleet__pb2.DeleteNodeRequest.SerializeToString,
                 response_deserializer=flwr_dot_proto_dot_fleet__pb2.DeleteNodeResponse.FromString,
                 )
-        self.Ping = channel.unary_unary(
-                '/flwr.proto.Fleet/Ping',
-                request_serializer=flwr_dot_proto_dot_fleet__pb2.PingRequest.SerializeToString,
-                response_deserializer=flwr_dot_proto_dot_fleet__pb2.PingResponse.FromString,
+        self.Heartbeat = channel.unary_unary(
+                '/flwr.proto.Fleet/Heartbeat',
+                request_serializer=flwr_dot_proto_dot_fleet__pb2.HeartbeatRequest.SerializeToString,
+                response_deserializer=flwr_dot_proto_dot_fleet__pb2.HeartbeatResponse.FromString,
                 )
         self.PullMessages = channel.unary_unary(
                 '/flwr.proto.Fleet/PullMessages',
@@ -68,7 +68,7 @@ class FleetServicer(object):
         context.set_details('Method not implemented!')
         raise NotImplementedError('Method not implemented!')
 
-    def Ping(self, request, context):
+    def Heartbeat(self, request, context):
         """Missing associated documentation comment in .proto file."""
         context.set_code(grpc.StatusCode.UNIMPLEMENTED)
         context.set_details('Method not implemented!')
@@ -118,10 +118,10 @@ def add_FleetServicer_to_server(servicer, server):
                     request_deserializer=flwr_dot_proto_dot_fleet__pb2.DeleteNodeRequest.FromString,
                     response_serializer=flwr_dot_proto_dot_fleet__pb2.DeleteNodeResponse.SerializeToString,
             ),
-            'Ping': grpc.unary_unary_rpc_method_handler(
-                    servicer.Ping,
-                    request_deserializer=flwr_dot_proto_dot_fleet__pb2.PingRequest.FromString,
-                    response_serializer=flwr_dot_proto_dot_fleet__pb2.PingResponse.SerializeToString,
+            'Heartbeat': grpc.unary_unary_rpc_method_handler(
+                    servicer.Heartbeat,
+                    request_deserializer=flwr_dot_proto_dot_fleet__pb2.HeartbeatRequest.FromString,
+                    response_serializer=flwr_dot_proto_dot_fleet__pb2.HeartbeatResponse.SerializeToString,
             ),
             'PullMessages': grpc.unary_unary_rpc_method_handler(
                     servicer.PullMessages,
@@ -188,7 +188,7 @@ class Fleet(object):
             insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
 
     @staticmethod
-    def Ping(request,
+    def Heartbeat(request,
             target,
             options=(),
             channel_credentials=None,
@@ -198,9 +198,9 @@ class Fleet(object):
             wait_for_ready=None,
             timeout=None,
             metadata=None):
-        return grpc.experimental.unary_unary(request, target, '/flwr.proto.Fleet/Ping',
-            flwr_dot_proto_dot_fleet__pb2.PingRequest.SerializeToString,
-            flwr_dot_proto_dot_fleet__pb2.PingResponse.FromString,
+        return grpc.experimental.unary_unary(request, target, '/flwr.proto.Fleet/Heartbeat',
+            flwr_dot_proto_dot_fleet__pb2.HeartbeatRequest.SerializeToString,
+            flwr_dot_proto_dot_fleet__pb2.HeartbeatResponse.FromString,
             options, channel_credentials,
             insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
 

flwr/proto/fleet_pb2_grpc.pyi

@@ -18,9 +18,9 @@ class FleetStub:
         flwr.proto.fleet_pb2.DeleteNodeRequest,
         flwr.proto.fleet_pb2.DeleteNodeResponse]
 
-    Ping: grpc.UnaryUnaryMultiCallable[
-        flwr.proto.fleet_pb2.PingRequest,
-        flwr.proto.fleet_pb2.PingResponse]
+    Heartbeat: grpc.UnaryUnaryMultiCallable[
+        flwr.proto.fleet_pb2.HeartbeatRequest,
+        flwr.proto.fleet_pb2.HeartbeatResponse]
 
     PullMessages: grpc.UnaryUnaryMultiCallable[
         flwr.proto.fleet_pb2.PullMessagesRequest,
@@ -62,10 +62,10 @@ class FleetServicer(metaclass=abc.ABCMeta):
     ) -> flwr.proto.fleet_pb2.DeleteNodeResponse: ...
 
     @abc.abstractmethod
-    def Ping(self,
-        request: flwr.proto.fleet_pb2.PingRequest,
+    def Heartbeat(self,
+        request: flwr.proto.fleet_pb2.HeartbeatRequest,
         context: grpc.ServicerContext,
-    ) -> flwr.proto.fleet_pb2.PingResponse: ...
+    ) -> flwr.proto.fleet_pb2.HeartbeatResponse: ...
 
     @abc.abstractmethod
     def PullMessages(self,

flwr/server/superlink/fleet/grpc_adapter/grpc_adapter_servicer.py

@@ -35,7 +35,7 @@ from flwr.proto.fab_pb2 import GetFabRequest  # pylint: disable=E0611
 from flwr.proto.fleet_pb2 import (  # pylint: disable=E0611
     CreateNodeRequest,
     DeleteNodeRequest,
-    PingRequest,
+    HeartbeatRequest,
     PullMessagesRequest,
     PushMessagesRequest,
 )
@@ -81,8 +81,8 @@ class GrpcAdapterServicer(grpcadapter_pb2_grpc.GrpcAdapterServicer, FleetService
             return _handle(request, context, CreateNodeRequest, self.CreateNode)
         if request.grpc_message_name == DeleteNodeRequest.__qualname__:
             return _handle(request, context, DeleteNodeRequest, self.DeleteNode)
-        if request.grpc_message_name == PingRequest.__qualname__:
-            return _handle(request, context, PingRequest, self.Ping)
+        if request.grpc_message_name == HeartbeatRequest.__qualname__:
+            return _handle(request, context, HeartbeatRequest, self.Heartbeat)
         if request.grpc_message_name == GetRunRequest.__qualname__:
             return _handle(request, context, GetRunRequest, self.GetRun)
         if request.grpc_message_name == GetFabRequest.__qualname__:

flwr/server/superlink/fleet/grpc_rere/fleet_servicer.py

@@ -29,8 +29,8 @@ from flwr.proto.fleet_pb2 import (  # pylint: disable=E0611
     CreateNodeResponse,
     DeleteNodeRequest,
     DeleteNodeResponse,
-    PingRequest,
-    PingResponse,
+    HeartbeatRequest,
+    HeartbeatResponse,
     PullMessagesRequest,
     PullMessagesResponse,
     PushMessagesRequest,
@@ -56,7 +56,11 @@ class FleetServicer(fleet_pb2_grpc.FleetServicer):
         self, request: CreateNodeRequest, context: grpc.ServicerContext
     ) -> CreateNodeResponse:
         """."""
-        log(INFO, "[Fleet.CreateNode] Request ping_interval=%s", request.ping_interval)
+        log(
+            INFO,
+            "[Fleet.CreateNode] Request heartbeat_interval=%s",
+            request.heartbeat_interval,
+        )
         log(DEBUG, "[Fleet.CreateNode] Request: %s", MessageToDict(request))
         response = message_handler.create_node(
             request=request,
@@ -77,10 +81,12 @@ class FleetServicer(fleet_pb2_grpc.FleetServicer):
             state=self.state_factory.state(),
         )
 
-    def Ping(self, request: PingRequest, context: grpc.ServicerContext) -> PingResponse:
+    def Heartbeat(
+        self, request: HeartbeatRequest, context: grpc.ServicerContext
+    ) -> HeartbeatResponse:
         """."""
-        log(DEBUG, "[Fleet.Ping] Request: %s", MessageToDict(request))
-        return message_handler.ping(
+        log(DEBUG, "[Fleet.Heartbeat] Request: %s", MessageToDict(request))
+        return message_handler.heartbeat(
             request=request,
             state=self.state_factory.state(),
         )

flwr/server/superlink/fleet/message_handler/message_handler.py

@@ -33,8 +33,8 @@ from flwr.proto.fleet_pb2 import (  # pylint: disable=E0611
     CreateNodeResponse,
     DeleteNodeRequest,
     DeleteNodeResponse,
-    PingRequest,
-    PingResponse,
+    HeartbeatRequest,
+    HeartbeatResponse,
     PullMessagesRequest,
     PullMessagesResponse,
     PushMessagesRequest,
@@ -58,7 +58,7 @@ def create_node(
 ) -> CreateNodeResponse:
     """."""
     # Create node
-    node_id = state.create_node(ping_interval=request.ping_interval)
+    node_id = state.create_node(heartbeat_interval=request.heartbeat_interval)
     return CreateNodeResponse(node=Node(node_id=node_id))
 
 
@@ -73,13 +73,13 @@ def delete_node(request: DeleteNodeRequest, state: LinkState) -> DeleteNodeRespo
     return DeleteNodeResponse()
 
 
-def ping(
-    request: PingRequest,  # pylint: disable=unused-argument
+def heartbeat(
+    request: HeartbeatRequest,  # pylint: disable=unused-argument
     state: LinkState,  # pylint: disable=unused-argument
-) -> PingResponse:
+) -> HeartbeatResponse:
     """."""
-    res = state.acknowledge_ping(request.node.node_id, request.ping_interval)
-    return PingResponse(success=res)
+    res = state.acknowledge_heartbeat(request.node.node_id, request.heartbeat_interval)
+    return HeartbeatResponse(success=res)
 
 
 def pull_messages(

flwr/server/superlink/fleet/rest_rere/rest_api.py

@@ -29,8 +29,8 @@ from flwr.proto.fleet_pb2 import (  # pylint: disable=E0611
     CreateNodeResponse,
     DeleteNodeRequest,
     DeleteNodeResponse,
-    PingRequest,
-    PingResponse,
+    HeartbeatRequest,
+    HeartbeatResponse,
     PullMessagesRequest,
     PullMessagesResponse,
     PushMessagesRequest,
@@ -126,14 +126,14 @@ async def push_message(request: PushMessagesRequest) -> PushMessagesResponse:
     return message_handler.push_messages(request=request, state=state)
 
 
-@rest_request_response(PingRequest)
-async def ping(request: PingRequest) -> PingResponse:
-    """Ping."""
+@rest_request_response(HeartbeatRequest)
+async def heartbeat(request: HeartbeatRequest) -> HeartbeatResponse:
+    """Heartbeat."""
     # Get state from app
     state: LinkState = cast(LinkStateFactory, app.state.STATE_FACTORY).state()
 
     # Handle message
-    return message_handler.ping(request=request, state=state)
+    return message_handler.heartbeat(request=request, state=state)
 
 
 @rest_request_response(GetRunRequest)
@@ -164,7 +164,7 @@ routes = [
     Route("/api/v0/fleet/delete-node", delete_node, methods=["POST"]),
     Route("/api/v0/fleet/pull-messages", pull_message, methods=["POST"]),
     Route("/api/v0/fleet/push-messages", push_message, methods=["POST"]),
-    Route("/api/v0/fleet/ping", ping, methods=["POST"]),
+    Route("/api/v0/fleet/heartbeat", heartbeat, methods=["POST"]),
     Route("/api/v0/fleet/get-run", get_run, methods=["POST"]),
     Route("/api/v0/fleet/get-fab", get_fab, methods=["POST"]),
 ]

flwr/server/superlink/fleet/vce/vce_api.py

@@ -31,9 +31,9 @@ from flwr.client.clientapp.utils import get_load_client_app_fn
 from flwr.client.run_info_store import DeprecatedRunInfoStore
 from flwr.common import Message
 from flwr.common.constant import (
+    HEARTBEAT_MAX_INTERVAL,
     NUM_PARTITIONS_KEY,
     PARTITION_ID_KEY,
-    PING_MAX_INTERVAL,
     ErrorCode,
 )
 from flwr.common.logger import log
@@ -53,7 +53,7 @@ def _register_nodes(
     nodes_mapping: NodeToPartitionMapping = {}
     state = state_factory.state()
     for i in range(num_nodes):
-        node_id = state.create_node(ping_interval=PING_MAX_INTERVAL)
+        node_id = state.create_node(heartbeat_interval=HEARTBEAT_MAX_INTERVAL)
         nodes_mapping[node_id] = i
     log(DEBUG, "Registered %i nodes", len(nodes_mapping))
     return nodes_mapping

flwr/server/superlink/linkstate/in_memory_linkstate.py

@@ -25,9 +25,9 @@ from uuid import UUID, uuid4
 
 from flwr.common import Context, Message, log, now
 from flwr.common.constant import (
+    HEARTBEAT_PATIENCE,
     MESSAGE_TTL_TOLERANCE,
     NODE_ID_NUM_BYTES,
-    PING_PATIENCE,
     RUN_ID_NUM_BYTES,
     SUPERLINK_NODE_ID,
     Status,
@@ -61,7 +61,7 @@ class InMemoryLinkState(LinkState):  # pylint: disable=R0902,R0904
 
     def __init__(self) -> None:
 
-        # Map node_id to (online_until, ping_interval)
+        # Map node_id to (online_until, heartbeat_interval)
         self.node_ids: dict[int, tuple[float, float]] = {}
         self.public_key_to_node_id: dict[bytes, int] = {}
         self.node_id_to_public_key: dict[int, bytes] = {}
@@ -322,7 +322,7 @@ class InMemoryLinkState(LinkState):  # pylint: disable=R0902,R0904
         """
         return len(self.message_res_store)
 
-    def create_node(self, ping_interval: float) -> int:
+    def create_node(self, heartbeat_interval: float) -> int:
         """Create, store in the link state, and return `node_id`."""
         # Sample a random int64 as node_id
         node_id = generate_rand_int_from_bytes(
@@ -334,8 +334,11 @@ class InMemoryLinkState(LinkState):  # pylint: disable=R0902,R0904
                 log(ERROR, "Unexpected node registration failure.")
                 return 0
 
-            # Mark the node online util time.time() + ping_interval
-            self.node_ids[node_id] = (time.time() + ping_interval, ping_interval)
+            # Mark the node online until time.time() + heartbeat_interval
+            self.node_ids[node_id] = (
+                time.time() + heartbeat_interval,
+                heartbeat_interval,
+            )
             return node_id
 
     def delete_node(self, node_id: int) -> None:
@@ -536,17 +539,19 @@ class InMemoryLinkState(LinkState):  # pylint: disable=R0902,R0904
                 return None
             return self.federation_options[run_id]
 
-    def acknowledge_ping(self, node_id: int, ping_interval: float) -> bool:
-        """Acknowledge a ping received from a node, serving as a heartbeat.
+    def acknowledge_heartbeat(self, node_id: int, heartbeat_interval: float) -> bool:
+        """Acknowledge a heartbeat received from a node, serving as a heartbeat.
 
-        It allows for one missed ping (in a PING_PATIENCE * ping_interval) before
-        marking the node as offline, where PING_PATIENCE = 2 in default.
+        A node is considered online as long as it sends heartbeats within
+        the tolerated interval: HEARTBEAT_PATIENCE × heartbeat_interval.
+        HEARTBEAT_PATIENCE = N allows for N-1 missed heartbeat before
+        the node is marked as offline.
         """
         with self.lock:
             if node_id in self.node_ids:
                 self.node_ids[node_id] = (
-                    time.time() + PING_PATIENCE * ping_interval,
-                    ping_interval,
+                    time.time() + HEARTBEAT_PATIENCE * heartbeat_interval,
+                    heartbeat_interval,
                 )
                 return True
         return False

flwr/server/superlink/linkstate/linkstate.py

@@ -128,7 +128,7 @@ class LinkState(abc.ABC):  # pylint: disable=R0904
         """Get all instruction Message IDs for the given run_id."""
 
     @abc.abstractmethod
-    def create_node(self, ping_interval: float) -> int:
+    def create_node(self, heartbeat_interval: float) -> int:
         """Create, store in the link state, and return `node_id`."""
 
     @abc.abstractmethod
@@ -267,22 +267,27 @@ class LinkState(abc.ABC):  # pylint: disable=R0904
         """Retrieve all currently stored `node_public_keys` as a set."""
 
     @abc.abstractmethod
-    def acknowledge_ping(self, node_id: int, ping_interval: float) -> bool:
-        """Acknowledge a ping received from a node, serving as a heartbeat.
+    def acknowledge_heartbeat(self, node_id: int, heartbeat_interval: float) -> bool:
+        """Acknowledge a heartbeat received from a node.
+
+        A node is considered online as long as it sends heartbeats within
+        the tolerated interval: HEARTBEAT_PATIENCE × heartbeat_interval.
+        HEARTBEAT_PATIENCE = N allows for N-1 missed heartbeat before
+        the node is marked as offline.
 
         Parameters
         ----------
         node_id : int
-            The `node_id` from which the ping was received.
-        ping_interval : float
+            The `node_id` from which the heartbeat was received.
+        heartbeat_interval : float
             The interval (in seconds) from the current timestamp within which the next
-            ping from this node must be received. This acts as a hard deadline to ensure
-            an accurate assessment of the node's availability.
+            heartbeat from this node must be received. This acts as a hard deadline to
+            ensure an accurate assessment of the node's availability.
 
         Returns
         -------
         is_acknowledged : bool
-            True if the ping is successfully acknowledged; otherwise, False.
+            True if the heartbeat is successfully acknowledged; otherwise, False.
         """
 
     @abc.abstractmethod

flwr/server/superlink/linkstate/sqlite_linkstate.py

@@ -28,9 +28,9 @@ from uuid import UUID, uuid4
 
 from flwr.common import Context, Message, Metadata, log, now
 from flwr.common.constant import (
+    HEARTBEAT_PATIENCE,
     MESSAGE_TTL_TOLERANCE,
     NODE_ID_NUM_BYTES,
-    PING_PATIENCE,
     RUN_ID_NUM_BYTES,
     SUPERLINK_NODE_ID,
     Status,
@@ -74,7 +74,7 @@ SQL_CREATE_TABLE_NODE = """
 CREATE TABLE IF NOT EXISTS node(
     node_id         INTEGER UNIQUE,
     online_until    REAL,
-    ping_interval   REAL,
+    heartbeat_interval   REAL,
     public_key      BLOB
 );
 """
@@ -595,7 +595,7 @@ class SqliteLinkState(LinkState):  # pylint: disable=R0904
 
         return {UUID(row["message_id"]) for row in rows}
 
-    def create_node(self, ping_interval: float) -> int:
+    def create_node(self, heartbeat_interval: float) -> int:
         """Create, store in the link state, and return `node_id`."""
         # Sample a random uint64 as node_id
         uint64_node_id = generate_rand_int_from_bytes(
@@ -607,18 +607,18 @@ class SqliteLinkState(LinkState):  # pylint: disable=R0904
 
         query = (
             "INSERT INTO node "
-            "(node_id, online_until, ping_interval, public_key) "
+            "(node_id, online_until, heartbeat_interval, public_key) "
             "VALUES (?, ?, ?, ?)"
         )
 
-        # Mark the node online util time.time() + ping_interval
+        # Mark the node online util time.time() + heartbeat_interval
         try:
             self.query(
                 query,
                 (
                     sint64_node_id,
-                    time.time() + ping_interval,
-                    ping_interval,
+                    time.time() + heartbeat_interval,
+                    heartbeat_interval,
                     b"",  # Initialize with an empty public key
                 ),
             )
@@ -926,11 +926,13 @@ class SqliteLinkState(LinkState):  # pylint: disable=R0904
         row = rows[0]
         return configrecord_from_bytes(row["federation_options"])
 
-    def acknowledge_ping(self, node_id: int, ping_interval: float) -> bool:
-        """Acknowledge a ping received from a node, serving as a heartbeat.
+    def acknowledge_heartbeat(self, node_id: int, heartbeat_interval: float) -> bool:
+        """Acknowledge a heartbeat received from a node, serving as a heartbeat.
 
-        It allows for one missed ping (in a PING_PATIENCE * ping_interval) before
-        marking the node as offline, where PING_PATIENCE = 2 in default.
+        A node is considered online as long as it sends heartbeats within
+        the tolerated interval: HEARTBEAT_PATIENCE × heartbeat_interval.
+        HEARTBEAT_PATIENCE = N allows for N-1 missed heartbeat before
+        the node is marked as offline.
         """
         sint64_node_id = convert_uint64_to_sint64(node_id)
 
@@ -939,13 +941,15 @@ class SqliteLinkState(LinkState):  # pylint: disable=R0904
         if not self.query(query, (sint64_node_id,)):
             return False
 
-        # Update `online_until` and `ping_interval` for the given `node_id`
-        query = "UPDATE node SET online_until = ?, ping_interval = ? WHERE node_id = ?"
+        # Update `online_until` and `heartbeat_interval` for the given `node_id`
+        query = (
+            "UPDATE node SET online_until = ?, heartbeat_interval = ? WHERE node_id = ?"
+        )
         self.query(
             query,
             (
-                time.time() + PING_PATIENCE * ping_interval,
-                ping_interval,
+                time.time() + HEARTBEAT_PATIENCE * heartbeat_interval,
+                heartbeat_interval,
                 sint64_node_id,
             ),
         )

flwr/server/superlink/linkstate/utils.py

@@ -21,6 +21,7 @@ from uuid import UUID, uuid4
 
 from flwr.common import ConfigRecord, Context, Error, Message, Metadata, now, serde
 from flwr.common.constant import (
+    HEARTBEAT_PATIENCE,
     SUPERLINK_NODE_ID,
     ErrorCode,
     MessageType,
@@ -56,8 +57,8 @@ REPLY_MESSAGE_UNAVAILABLE_ERROR_REASON = (
     "Error: Reply Message Unavailable - The reply message has expired."
 )
 NODE_UNAVAILABLE_ERROR_REASON = (
-    "Error: Node Unavailable - The destination node is currently unavailable. "
-    "It exceeds twice the time limit specified in its last ping."
+    "Error: Node Unavailable — The destination node failed to report a heartbeat "
+    f"within {HEARTBEAT_PATIENCE} × its expected interval."
 )
 
 

{flwr_nightly-1.19.0.dev20250429.dist-info → flwr_nightly-1.19.0.dev20250430.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flwr-nightly
-Version: 1.19.0.dev20250429
+Version: 1.19.0.dev20250430
 Summary: Flower: A Friendly Federated AI Framework
 Home-page: https://flower.ai
 License: Apache-2.0

{flwr_nightly-1.19.0.dev20250429.dist-info → flwr_nightly-1.19.0.dev20250430.dist-info}/RECORD

@@ -86,9 +86,8 @@ flwr/client/grpc_client/__init__.py,sha256=MDOckOODn-FJnkkFEfb2JO-2G97wrBr_TTqht
 flwr/client/grpc_client/connection.py,sha256=xAyvcTVr7bkwUfR5P3D_LKlZYiyySpt5sEwORA1h8Gc,9189
 flwr/client/grpc_rere_client/__init__.py,sha256=i7iS0Lt8B7q0E2L72e4F_YrKm6ClRKnd71PNA6PW2O0,752
 flwr/client/grpc_rere_client/client_interceptor.py,sha256=zFaVHw6AxeNO-7eCKKb-RxrPa7zbM5Z-2-1Efc4adQY,2451
-flwr/client/grpc_rere_client/connection.py,sha256=REllHl52LGLmZBQINMCMGBeSX2JxdjJaW2N0h89kPBY,11777
-flwr/client/grpc_rere_client/grpc_adapter.py,sha256=PRzGkE4CQbir5bMdDkZxF7Jt1y7wOpFfwA7qf-0m_Fo,5601
-flwr/client/heartbeat.py,sha256=bhmZMbdJTtn4zL-Y9aFtOf0skaymJvdf9tH8gyAWaVk,2404
+flwr/client/grpc_rere_client/connection.py,sha256=YUqq7RoRuJok2HKcwK1k28B5lFZAhLLyOZ0ByesfqfM,11847
+flwr/client/grpc_rere_client/grpc_adapter.py,sha256=s8kaM8uM4hdF1DLt8vniUH1FmygE2S-rdiolZOpHKHE,5631
 flwr/client/message_handler/__init__.py,sha256=0lyljDVqre3WljiZbPcwCCf8GiIaSVI_yo_ylEyPwSE,719
 flwr/client/message_handler/message_handler.py,sha256=-vZKGg2gP81182LFXDmiZtajLlIfZjV6FyMS43qQVwU,6532
 flwr/client/mod/__init__.py,sha256=AtV4Y5UGuYqJdTg7bJ--KtfOZUYLGDPMy616LvtP5W4,1151
@@ -105,7 +104,7 @@ flwr/client/nodestate/nodestate.py,sha256=-LAjZOnS7VyHC05ll3b31cYDjwAt6l4WmYt7du
 flwr/client/nodestate/nodestate_factory.py,sha256=UYTDCcwK_baHUmkzkJDxL0UEqvtTfOMlQRrROMCd0Xo,1430
 flwr/client/numpy_client.py,sha256=Qq6ghsIAop2slKqAfgiI5NiHJ4LIxGmrik3Ror4_XVc,9581
 flwr/client/rest_client/__init__.py,sha256=MBiuK62hj439m9rtwSwI184Hth6Tt5GbmpNMyl3zkZY,735
-flwr/client/rest_client/connection.py,sha256=XWQEKPHynRCcvVRENq40TPvd0_boj-5OzVmWkIH5GgE,12904
+flwr/client/rest_client/connection.py,sha256=xDjs7y50adX-SL8AiAQvELQcVzmxSu5vYkLGL_s1Epo,12575
 flwr/client/run_info_store.py,sha256=MaJ3UQ-07hWtK67wnWu0zR29jrk0fsfgJX506dvEOfE,4042
 flwr/client/supernode/__init__.py,sha256=i3gFbV5ie_FGyRMpzOvqtZAi0Z0ChIEJ7I2Kr0ym0PM,793
 flwr/client/supernode/app.py,sha256=lURLjP8jiOWhlX3-uh-7t_l1o_JEUz_FmkuNY91xmUQ,8975
@@ -116,7 +115,7 @@ flwr/common/args.py,sha256=-aX_jVnSaDrJR2KZ8Wq0Y3dQHII4R4MJtJOIXzVUA0c,5417
 flwr/common/auth_plugin/__init__.py,sha256=m271m9YjK2QfKDOuIIhcTvGmv1GWh1PL97QB05NTSHs,887
 flwr/common/auth_plugin/auth_plugin.py,sha256=GaXw4IiU2DkVNkp5S9ue821sbkU9zWSu6HSVZetEdjs,3938
 flwr/common/config.py,sha256=glcZDjco-amw1YfQcYTFJ4S1pt9APoexT-mf1QscuHs,13960
-flwr/common/constant.py,sha256=pMeE1y3OTy9--9mEd4-UtsFTtr904YIdcrUVDO0KwnI,6984
+flwr/common/constant.py,sha256=_UFQfhBpDZ72uSRQqi3UNN4GlzEbog6sszA0it3m81Q,7132
 flwr/common/context.py,sha256=Be8obQR_OvEDy1OmshuUKxGRQ7Qx89mf5F4xlhkR10s,2407
 flwr/common/date.py,sha256=1ZT2cRSpC2DJqprOVTLXYCR_O2_OZR0zXO_brJ3LqWc,1554
 flwr/common/differential_privacy.py,sha256=FdlpdpPl_H_2HJa8CQM1iCUGBBQ5Dc8CzxmHERM-EoE,6148
@@ -129,6 +128,7 @@ flwr/common/exit/exit.py,sha256=mJgbqMlVlwAgYtq-Vedj53wO4VxcDcy_P-GzqGK-1GQ,3452
 flwr/common/exit/exit_code.py,sha256=PNEnCrZfOILjfDAFu5m-2YWEJBrk97xglq4zCUlqV7E,3470
 flwr/common/exit_handlers.py,sha256=MEk5_savTLphn-6lW57UQlos-XrFA39XEBn-OF1vXXg,3174
 flwr/common/grpc.py,sha256=manTaHaPiyYngUq1ErZvvV2B2GxlXUUUGRy3jc3TBIQ,9798
+flwr/common/heartbeat.py,sha256=yzi-gWH5wswdg0hfQwxwGkjI5twxIHBBVW45MD5QITI,3924
 flwr/common/logger.py,sha256=JbRf6E2vQxXzpDBq1T8IDUJo_usu3gjWEBPQ6uKcmdg,13049
 flwr/common/message.py,sha256=znr205Erq2hkxwFbvNNCsQTRS2UKv_Qsyu0sFNEhEAw,23721
 flwr/common/object_ref.py,sha256=p3SfTeqo3Aj16SkB-vsnNn01zswOPdGNBitcbRnqmUk,9134
@@ -173,10 +173,10 @@ flwr/proto/fab_pb2.py,sha256=2Nu0WaWxDZ8TbutMtctjdcGM7OtXiyP4kmCgg5o7Jjw,1627
 flwr/proto/fab_pb2.pyi,sha256=AMXpiDK0fo3nZWjxsC2E4otSaVjyQbU7iiWKrsSZavs,2395
 flwr/proto/fab_pb2_grpc.py,sha256=1oboBPFxaTEXt9Aw7EAj8gXHDCNMhZD2VXqocC9l_gk,159
 flwr/proto/fab_pb2_grpc.pyi,sha256=ff2TSiLVnG6IVQcTGzb2DIH3XRSoAvAo_RMcvbMFyc0,76
-flwr/proto/fleet_pb2.py,sha256=mICXsWQuShwkN-9PcksCINE0HwiqZ2343h5_tL6V6A4,4818
-flwr/proto/fleet_pb2.pyi,sha256=wmDweUv8CLErbPXXrvhUAbUH9JBR9z39y7hOSplXAD4,7895
-flwr/proto/fleet_pb2_grpc.py,sha256=7YoeSCjEfZ-sIVs9CMduH55IaCHin2VZBaxJt9n7acY,12260
-flwr/proto/fleet_pb2_grpc.pyi,sha256=y9XDpCUW626CnNvAjwzeorEN2thVlJ7OF1LeUnUPIwo,3240
+flwr/proto/fleet_pb2.py,sha256=mjTDr6tFlP8TjSIH7nODmJ3P02gUBqdIsaE7ysjFc58,4872
+flwr/proto/fleet_pb2.pyi,sha256=Zy8XTn-vRAUIYMZmwfZQ9beotu01EQEUR1BROsmiExk,7980
+flwr/proto/fleet_pb2_grpc.py,sha256=hyjCT3Rm44ZJoYww1XXHjsgfA7mSGEYdesAdpy--OFY,12325
+flwr/proto/fleet_pb2_grpc.pyi,sha256=w-7uzmuUEoPHFX97exLi-gK9ddHIlsA3qoDPuIx4TOY,3270
 flwr/proto/grpcadapter_pb2.py,sha256=PJ8DtfeV29g_y4Z3aNZlSZocLqSxeLmTsYCdOZDYCiE,1843
 flwr/proto/grpcadapter_pb2.pyi,sha256=AR77gDsF6f8zqSIQp3877DUd7S8lP95lFak5Ir_WPkw,1716
 flwr/proto/grpcadapter_pb2_grpc.py,sha256=rRNuNES5nBugUZWfeA8oAy8dMHgzqU_PF1srTseo3b8,2634
@@ -268,30 +268,30 @@ flwr/server/superlink/ffs/ffs.py,sha256=6w7wy71i7tbuJwqEgdeCa49JejXMEof3jujURN_R
 flwr/server/superlink/ffs/ffs_factory.py,sha256=pK-g3LMelvWTV6N9Cd-j-_-FdcGbRFTKNsWaqmlBDSk,1490
 flwr/server/superlink/fleet/__init__.py,sha256=Uiwr33yfW_eL-pEfj80c_JUhIKRkCPsN1JSs2v4aglU,711
 flwr/server/superlink/fleet/grpc_adapter/__init__.py,sha256=fUu1V63YrzjxAOZnBJx99WjuD4Mro7dJIFH-1V4NLV8,742
-flwr/server/superlink/fleet/grpc_adapter/grpc_adapter_servicer.py,sha256=MyeEKl1oPyVRpPgd9CCGboTSJowGttRTOdSk6kn_3pY,4160
+flwr/server/superlink/fleet/grpc_adapter/grpc_adapter_servicer.py,sha256=2hp617zisimdxm1KyMc5JapfMHGG_2X4lAacDFIbQcc,4180
 flwr/server/superlink/fleet/grpc_bidi/__init__.py,sha256=dOM49q1b9MrtUr5jldjEnQ38NhcUyYs-zC3gsJb1TtI,735
 flwr/server/superlink/fleet/grpc_bidi/flower_service_servicer.py,sha256=UKEp-3YBaTvNt7vKZW7KLgK5xsAiO7jxU-omG7CaO_s,6021
 flwr/server/superlink/fleet/grpc_bidi/grpc_bridge.py,sha256=KouR9PUcrPmMtoLooF4O9SRAwIvfiroo8mPmqUc2EZc,6485
 flwr/server/superlink/fleet/grpc_bidi/grpc_client_proxy.py,sha256=iSf0mbBAlig7G6subQwBSVjcUCgSihONKdZ1RmQPTOk,4887
 flwr/server/superlink/fleet/grpc_bidi/grpc_server.py,sha256=OsS-6GgCIzMMZDVu5Y-OKjynHVUrpdc_5OrtuB-IbU0,5174
 flwr/server/superlink/fleet/grpc_rere/__init__.py,sha256=ahDJJ1e-lDxBpeBMgPk7YZt2wB38_QltcpOC0gLbpFs,758
-flwr/server/superlink/fleet/grpc_rere/fleet_servicer.py,sha256=N2Q5MsMO_upcqJ_A4sILj4lM3i-PoWAFRPKvN4JK_KU,5528
+flwr/server/superlink/fleet/grpc_rere/fleet_servicer.py,sha256=IiFqOykZuGL4ASTJ96jHDO-WKEF5tzb5E85BCsMdg7M,5634
 flwr/server/superlink/fleet/grpc_rere/server_interceptor.py,sha256=DrHubsaLgJCwCeeJPYogQTiP0xYqjxwnT9rh7OP7BoU,6984
 flwr/server/superlink/fleet/message_handler/__init__.py,sha256=fHsRV0KvJ8HtgSA4_YBsEzuhJLjO8p6xx4aCY2oE1p4,731
-flwr/server/superlink/fleet/message_handler/message_handler.py,sha256=78mKlPLp_RpvUM7ZpBMz4pLGn43eOQ7aqtQ-3P2FK1k,5242
+flwr/server/superlink/fleet/message_handler/message_handler.py,sha256=rxhrjhsvpc8RVi_EZUHB0O47vbI5r6iTaJZYaBxCuuo,5292
 flwr/server/superlink/fleet/rest_rere/__init__.py,sha256=Lzc93nA7tDqoy-zRUaPG316oqFiZX1HUCL5ELaXY_xw,735
-flwr/server/superlink/fleet/rest_rere/rest_api.py,sha256=xmxaRBrLS7I8DTr_EgVm0N_HcdrSzXv0yisUADxblRk,6710
+flwr/server/superlink/fleet/rest_rere/rest_api.py,sha256=5I6tf9UCYJ92mIckcFvmX-h8Emvo-sN6hp-R82CPz2M,6760
 flwr/server/superlink/fleet/vce/__init__.py,sha256=XOKbAWOzlCqEOQ3M2cBYkH7HKA7PxlbCJMunt-ty-DY,784
 flwr/server/superlink/fleet/vce/backend/__init__.py,sha256=PPH89Yqd1XKm-sRJN6R0WQlKT_b4v54Kzl2yzHAFzM8,1437
 flwr/server/superlink/fleet/vce/backend/backend.py,sha256=-wDHjgAy5mrfEgXj0GxkJI7lhEbgSUyPwmNAf9ZcDzc,2193
 flwr/server/superlink/fleet/vce/backend/raybackend.py,sha256=Hx9hxL7lju1_VJoAwkhBOGerZ3628u0P1zgkPhGWRPY,7154
-flwr/server/superlink/fleet/vce/vce_api.py,sha256=asV52hyO-mBcPsK3I1UrmAh-TGjeJCNKtzPsPuwZWXs,12765
+flwr/server/superlink/fleet/vce/vce_api.py,sha256=m7WUiHRl-jTqzjH3cqNCj3RXe3ohT6V6I0JIR6zWZj8,12780
 flwr/server/superlink/linkstate/__init__.py,sha256=OtsgvDTnZLU3k0sUbkHbqoVwW6ql2FDmb6uT6DbNkZo,1064
-flwr/server/superlink/linkstate/in_memory_linkstate.py,sha256=4uYkKlGcZqZLY3tQp-1xNlp_JgIXKLr5NYIi0aGwR-8,22291
-flwr/server/superlink/linkstate/linkstate.py,sha256=IjQHAkWsbYkez5ht5inWwQapyjwSRYkVkLsZJDBbu-Y,11847
+flwr/server/superlink/linkstate/in_memory_linkstate.py,sha256=wnjwVUyAZBaXY9PviGHWTa5kOvH9JiiJ3vnUEx6Z4Ss,22501
+flwr/server/superlink/linkstate/linkstate.py,sha256=6ANy92MaT0eA1ocrzEbblGNRuIqw6nIB4infGHGkDD8,12121
 flwr/server/superlink/linkstate/linkstate_factory.py,sha256=8RlosqSpKOoD_vhUUQPY0jtE3A84GeF96Z7sWNkRRcA,2069
-flwr/server/superlink/linkstate/sqlite_linkstate.py,sha256=WX13W1cY5swG1mg239Szr5n-BdUVsnAu0lLvv16fjck,39627
-flwr/server/superlink/linkstate/utils.py,sha256=tnkuC8EITi4kxWcN0QZIO5N5lQ9cRra36B42mTSJYkI,15358
+flwr/server/superlink/linkstate/sqlite_linkstate.py,sha256=B42abgovs027Z3G9iI_HPEPP4zIjMKaTjvYVhbfhupc,39828
+flwr/server/superlink/linkstate/utils.py,sha256=AJs9jTAEK7JnjF2AODXnOfy0pKAKpe6oUWPCanAP57s,15382
 flwr/server/superlink/serverappio/__init__.py,sha256=Fy4zJuoccZe5mZSEIpOmQvU6YeXFBa1M4eZuXXmJcn8,717
 flwr/server/superlink/serverappio/serverappio_grpc.py,sha256=opJ6SYwIAbu4NWEo3K-VxFO-tMSFmE4H3i2HwHIVRzw,2173
 flwr/server/superlink/serverappio/serverappio_servicer.py,sha256=olLC0PvFY09hRWSZyJvJo-ituSDX45fvEVGaTlKufu8,13122
@@ -327,7 +327,7 @@ flwr/superexec/exec_servicer.py,sha256=Z0YYfs6eNPhqn8rY0x_R04XgR2mKFpggt07IH0EhU
 flwr/superexec/exec_user_auth_interceptor.py,sha256=iqygALkOMBUu_s_R9G0mFThZA7HTUzuXCLgxLCefiwI,4440
 flwr/superexec/executor.py,sha256=M5ucqSE53jfRtuCNf59WFLqQvA1Mln4741TySeZE7qQ,3112
 flwr/superexec/simulation.py,sha256=j6YwUvBN7EQ09ID7MYOCVZ70PGbuyBy8f9bXU0EszEM,4088
-flwr_nightly-1.19.0.dev20250429.dist-info/METADATA,sha256=Wdio99lEQ-6VRfA9YQV-kd3zd9QODC2pxQcHABOzbk4,15868
-flwr_nightly-1.19.0.dev20250429.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-flwr_nightly-1.19.0.dev20250429.dist-info/entry_points.txt,sha256=2-1L-GNKhwGw2_7_RoH55vHw2SIHjdAQy3HAVAWl9PY,374
-flwr_nightly-1.19.0.dev20250429.dist-info/RECORD,,
+flwr_nightly-1.19.0.dev20250430.dist-info/METADATA,sha256=vEFJGaaBBFiNbovUnzUXajKU8SWtwGGOiP-lIt-Biuk,15868
+flwr_nightly-1.19.0.dev20250430.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+flwr_nightly-1.19.0.dev20250430.dist-info/entry_points.txt,sha256=2-1L-GNKhwGw2_7_RoH55vHw2SIHjdAQy3HAVAWl9PY,374
+flwr_nightly-1.19.0.dev20250430.dist-info/RECORD,,

flwr/client/heartbeat.py

@@ -1,74 +0,0 @@
-# Copyright 2025 Flower Labs GmbH. All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-# ==============================================================================
-"""Heartbeat utility functions."""
-
-
-import threading
-from typing import Callable
-
-import grpc
-
-from flwr.common.constant import PING_CALL_TIMEOUT
-from flwr.common.retry_invoker import RetryInvoker, RetryState, exponential
-
-
-def _ping_loop(ping_fn: Callable[[], None], stop_event: threading.Event) -> None:
-    def wait_fn(wait_time: float) -> None:
-        if not stop_event.is_set():
-            stop_event.wait(wait_time)
-
-    def on_backoff(state: RetryState) -> None:
-        err = state.exception
-        if not isinstance(err, grpc.RpcError):
-            return
-        status_code = err.code()
-        # If ping call timeout is triggered
-        if status_code == grpc.StatusCode.DEADLINE_EXCEEDED:
-            # Avoid long wait time.
-            if state.actual_wait is None:
-                return
-            state.actual_wait = max(state.actual_wait - PING_CALL_TIMEOUT, 0.0)
-
-    def wrapped_ping() -> None:
-        if not stop_event.is_set():
-            ping_fn()
-
-    retrier = RetryInvoker(
-        exponential,
-        grpc.RpcError,
-        max_tries=None,
-        max_time=None,
-        on_backoff=on_backoff,
-        wait_function=wait_fn,
-    )
-    while not stop_event.is_set():
-        retrier.invoke(wrapped_ping)
-
-
-def start_ping_loop(
-    ping_fn: Callable[[], None], stop_event: threading.Event
-) -> threading.Thread:
-    """Start a ping loop in a separate thread.
-
-    This function initializes a new thread that runs a ping loop, allowing for
-    asynchronous ping operations. The loop can be terminated through the provided stop
-    event.
-    """
-    thread = threading.Thread(
-        target=_ping_loop, args=(ping_fn, stop_event), daemon=True
-    )
-    thread.start()
-
-    return thread