nvflare.collab.api.call_opt module

class CallOption(expect_result: bool = True, blocking: bool = True, timeout: float = 60.0, secure: bool = False, optional: bool = False, target=None, parallel=0)[source]

Bases: object

CallOption defines behavior of a collab call.

Parameters:

  • expect_result – whether result is expected from the remote object.

  • blocking – whether the call is blocking. Only for group calls.

  • timeout – when expecting result, the max number of secs to wait for result.

  • secure – whether to use P2P secure messaging.

  • optional – whether the call is optional.

  • target – name of the collab object to be called.

  • parallel – maximum number of calls that may remain in flight at once.