nvflare.fuel.f3.cellnet.defs module

exception AbortRun

Bases: Exception

exception AuthenticationError

Bases: Exception

class CellChannel

Bases: object

AUX_COMMUNICATION = 'aux_communication'

CLIENT_COMMAND = 'client_command'

CLIENT_MAIN = 'admin'

CLIENT_SUB_WORKER_COMMAND = 'client_sub_worker_command'

MULTI_PROCESS_EXECUTOR = 'multi_process_executor'

RETURN_ONLY = 'return_only'

SERVER_COMMAND = 'server_command'

SERVER_MAIN = 'task'

SERVER_PARENT_LISTENER = 'server_parent_listener'

SIMULATOR_RUNNER = 'simulator_runner'

class CellChannelTopic

Bases: object

Challenge = 'challenge'

EXECUTE_RESULT = 'execute_result'

FIRE_EVENT = 'fire_event'

GET_TASK = 'get_task'

HEART_BEAT = 'heart_beat'

Quit = 'quit'

REPORT_JOB_FAILURE = 'report_job_failure'

Register = 'register'

SIMULATOR_WORKER_INIT = 'simulator_worker_init'

SUBMIT_RESULT = 'submit_result'

class CellPropertyKey

Bases: object

FQCN = 'fqcn'

class ConnectorRequirementKey

Bases: object

HOST = 'host'

SECURE = 'secure'

URL = 'url'

class Encoding

Bases: object

BYTES = 'bytes'

FOBS = 'fobs'

NONE = 'none'

class IdentityChallengeKey

Bases: object

CERT = 'cert'

COMMON_NAME = 'cn'

NONCE = 'nonce'

SIGNATURE = 'signature'

exception InvalidRequest

Bases: Exception

exception InvalidSession

Bases: Exception

class MessageHeaderKey

Bases: object

CHANNEL = 'cn__channel'

CLEAR_PAYLOAD_LEN = 'cn__clear_payload_len'

CONN_URL = 'cn__conn_url'

DESTINATION = 'cn__destination'

ENCRYPTED = 'cn__encrypted'

ERROR = 'cn__error'

FROM_CELL = 'cn__from'

MSG_TYPE = 'cn__msg_type'

OPTIONAL = 'cn__optional'

ORIGIN = 'cn__origin'

ORIGINAL_HEADERS = 'cn__original_headers'

PAYLOAD_ENCODING = 'cn__payload_encoding'

PAYLOAD_LEN = 'cn__payload_len'

REPLY_EXPECTED = 'cn__reply_expected'

REQ_ID = 'cn__req_id'

RETURN_CODE = 'cn__return_code'

RETURN_REASON = 'cn__return_reason'

ROUTE = 'cn__route'

SECURE = 'cn__secure'

SEND_TIME = 'cn__send_time'

TOPIC = 'cn__topic'

TO_CELL = 'cn__to'

class MessagePropKey

Bases: object

COMMON_NAME = 'cn__common_name'

ENDPOINT = 'cn__endpoint'

FUTURES = 'cn__futures'

class MessageType

Bases: object

REPLY = 'reply'

REQ = 'req'

RETURN = 'return'

class ReturnCode

Bases: object

ABORT_RUN = 'abort_run'

AUTHENTICATION_ERROR = 'authentication_error'

COMM_ERROR = 'comm_error'

FILTER_ERROR = 'filter_error'

INVALID_REQUEST = 'invalid_request'

INVALID_SESSION = 'invalid_session'

INVALID_TARGET = 'invalid_target'

MSG_TOO_BIG = 'msg_too_big'

OK = 'ok'

PROCESS_EXCEPTION = 'process_exception'

SERVICE_UNAVAILABLE = 'service_unavailable'

TARGET_UNREACHABLE = 'target_unreachable'

TIMEOUT = 'timeout'

UNAUTHENTICATED = 'unauthenticated'

class ReturnReason

Bases: object

CANT_FORWARD = 'cant_forward'

INTERCEPT = 'intercept'

class SSLConstants

Bases: object

hard coded names related to SSL.

CERT = 'ssl_cert'

PRIVATE_KEY = 'ssl_private_key'

ROOT_CERT = 'ssl_root_cert'

exception ServiceUnavailable

Bases: Exception

exception TargetCellUnreachable

Bases: Exception