nvflare.apis.shareable module

class ReservedHeaderKey

Bases: object

AUDIT_EVENT_ID = '__audit_event_id__'

CONTENT_TYPE = '__content_type__'

COOKIE_JAR = '__cookie_jar__'

ERROR = '__error__'

HEADERS = '__headers__'

MSG_ROOT_ID = '__msg_root_id__'

MSG_ROOT_TTL = '__msg_root_ttl__'

PASS_THROUGH = '__pass_through__'

PEER_CTX = '__peer_ctx__'

PEER_PROPS = '__peer_props__'

RC = '__rc__'

REPLY_IS_LATE = '__reply_is_late__'

TASK_ID = '__task_id__'

TASK_NAME = '__task_name__'

TASK_OPERATOR = '__task_operator__'

TOPIC = '__topic__'

WORKFLOW = '__workflow__'

class Shareable(data: dict | None = None)

Bases: dict

The information communicated between server and client.

Shareable is just a dict that can have any keys and values, defined by developers and users. It is recommended that keys are strings. Values must be serializable.

Init the Shareable.

add_cookie(name: str, data)

Add a cookie that is to be sent to the client and echoed back in response.

This method is intended to be called by the Server side.

Parameters:

• name – the name of the cookie

• data – the data of the cookie, which must be serializable

classmethod from_bytes(data: bytes)

Convert the data bytes into Model object.

Parameters:

data – a bytes object

Returns:

an object loaded by FOBS from data

get_cookie(name: str, default=None)

get_cookie_jar()

get_header(key: str, default=None)

get_peer_context()

get_peer_prop(key: str, default)

get_peer_props()

get_return_code(default='OK')

set_cookie_jar(jar)

set_header(key: str, value)

set_peer_context(peer_ctx)

set_peer_props(props: dict)

set_return_code(rc)

to_bytes() → bytes

Serialize the Model object into bytes.

Returns:

object serialized in bytes.

make_copy(source: Shareable, exclude_headers: list | None = None) → Shareable

Make a copy from the source. The content (non-headers) will be kept intact. Headers will be deep-copied into the new instance.

make_reply(rc, headers=None) → Shareable