nvflare.fuel.hci.proto module

class Buffer[source]

Bases: object

Buffer to append to for nvflare.fuel.hci.conn.Connection.

append_command(cmd: str)[source]
append_dict(data: dict)[source]
append_error(data: str)[source]
append_shutdown(msg: str)[source]
append_string(data: str)[source]
append_success(data: str)[source]
append_table(headers: List[str]) Table[source]
append_token(token: str)[source]
encode()[source]
reset()[source]
class ConfirmMethod[source]

Bases: object

AUTH = 'auth'
PASSWORD = 'pwd'
USER_NAME = 'username'
YESNO = 'yesno'
class CredentialType(value)[source]

Bases: str, Enum

An enumeration.

CERT = 'cert'
PASSWORD = 'password'
class InternalCommands[source]

Bases: object

CERT_LOGIN = '_cert_login'
CHECK_SESSION = '_check_session'
GET_CMD_LIST = '_commands'
LIST_SESSIONS = 'list_sessions'
LOGOUT = '_logout'
PWD_LOGIN = '_login'
make_error(data: str)[source]
validate_proto(line: str)[source]

Validate that the line being received is of the expected format.

Parameters:

line – str containing a JSON document

Returns: deserialized JSON document