# Copyright (c) 2021-2022, NVIDIA CORPORATION. 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.
from abc import ABC, abstractmethod
from nvflare.apis.client_engine_spec import ClientEngineSpec
from nvflare.apis.fl_context import FLContext
from nvflare.apis.shareable import Shareable
[docs]class ClientEngineExecutorSpec(ClientEngineSpec, ABC):
"""The ClientEngineExecutorSpec defines the ClientEngine APIs running in the child process."""
[docs] @abstractmethod
def register_aux_message_handler(self, topic: str, message_handle_func):
"""Register aux message handling function with specified topics.
Exception is raised when:
a handler is already registered for the topic;
bad topic - must be a non-empty string
bad message_handle_func - must be callable
Implementation Note:
This method should simply call the ClientAuxRunner's register_aux_message_handler method.
Args:
topic: the topic to be handled by the func
message_handle_func: the func to handle the message. Must follow aux_message_handle_func_signature.
"""
pass
[docs] @abstractmethod
def send_aux_request(self, topic: str, request: Shareable, timeout: float, fl_ctx: FLContext) -> Shareable:
"""Send a request to Server via the aux channel.
Implementation: simply calls the ClientAuxRunner's send_aux_request method.
Args:
topic: topic of the request
request: request to be sent
timeout: number of secs to wait for replies. 0 means fire-and-forget.
fl_ctx: FL context
Returns: a reply Shareable
"""
pass
[docs] @abstractmethod
def fire_and_forget_aux_request(self, topic: str, request: Shareable, fl_ctx: FLContext) -> Shareable:
"""Send an async request to Server via the aux channel.
Args:
topic: topic of the request
request: request to be sent
fl_ctx: FL context
Returns:
"""
pass
[docs] @abstractmethod
def aux_send(self, topic: str, request: Shareable, timeout: float, fl_ctx: FLContext) -> Shareable:
"""Send the request to the Server.
If reply is received, make sure to set peer_ctx into the reply shareable!
Args:
topic: topic of the request
request: request Shareable to be sent
timeout: number of secs to wait for reply. 0 means fire-and-forget.
fl_ctx: fl context
Returns: a reply.
"""
pass
[docs] @abstractmethod
def build_component(self, config_dict):
"""Build a component from the config_dict.
Args:
config_dict: config dict
"""
[docs] @abstractmethod
def abort_app(self, job_id: str, fl_ctx: FLContext):
"""Abort the running FL App on the client.
Args:
job_id: current_job_id
fl_ctx: FLContext
"""
pass