MSL-Network API Documentation

MSL-Network has very little functions or classes that need to be accessed in a user’s application.

Typically, only the Service class needs to be subclassed and the connect() function will be called to connect to the Network Manager for most applications using MSL-Network.

The msl.network.ssh module provides some functions for using SSH to connect to a remote computer. Starting a Service from another computer shows an example Python package that can automatically start a Network Manager and a Service on a Raspberry Pi from another computer.

The process of establishing a connection to a Manager and linking with a particular Service can be achieved by creating a LinkedClient. This can be useful if you only want to link with a single Service on a Manager.

Package Structure

• msl.network
  • version_info
• msl.network.client
  • connect()
  • filter_client_connect_kwargs()
  • Client
    • Client.admin_request()
    • Client.disconnect()
    • Client.is_connected()
    • Client.link()
    • Client.identities()
    • Client.spawn()
    • Client.unlink()
  • Link
    • Link.acquire_lock()
    • Link.release_lock()
    • Link.service_address
    • Link.service_attributes
    • Link.service_language
    • Link.service_max_clients
    • Link.service_name
    • Link.service_os
    • Link.disconnect()
    • Link.notification_handler()
    • Link.shutdown_service()
    • Link.unlink()
  • LinkedClient
    • LinkedClient.acquire_lock()
    • LinkedClient.admin_request()
    • LinkedClient.disconnect()
    • LinkedClient.identity()
    • LinkedClient.identities()
    • LinkedClient.is_connected()
    • LinkedClient.notification_handler()
    • LinkedClient.service_error_handler()
    • LinkedClient.shutdown_service()
    • LinkedClient.spawn()
    • LinkedClient.unlink()
    • LinkedClient.address_manager
    • LinkedClient.client
    • LinkedClient.link
    • LinkedClient.name
    • LinkedClient.port
    • LinkedClient.release_lock()
    • LinkedClient.service_address
    • LinkedClient.service_attributes
    • LinkedClient.service_language
    • LinkedClient.service_max_clients
    • LinkedClient.service_name
    • LinkedClient.service_os
• msl.network.constants
  • PORT
  • HOSTNAME
  • HOME_DIR
  • CERT_DIR
  • KEY_DIR
  • DATABASE
  • IS_WINDOWS
  • IS_LINUX
  • LOCALHOST_ALIASES
• msl.network.cryptography
  • generate_key()
  • load_key()
  • generate_certificate()
  • load_certificate()
  • get_default_cert_path()
  • get_default_key_path()
  • get_fingerprint()
  • get_metadata()
  • get_metadata_as_string()
  • get_ssl_context()
• msl.network.database
  • Database
    • Database.path
    • Database.connection
    • Database.cursor
    • Database.close()
    • Database.execute()
    • Database.tables()
    • Database.table_info()
    • Database.column_names()
    • Database.column_datatypes()
  • ConnectionsTable
    • ConnectionsTable.NAME
    • ConnectionsTable.insert()
    • ConnectionsTable.connections()
  • HostnamesTable
    • HostnamesTable.NAME
    • HostnamesTable.insert()
    • HostnamesTable.delete()
    • HostnamesTable.hostnames()
  • UsersTable
    • UsersTable.NAME
    • UsersTable.insert()
    • UsersTable.update()
    • UsersTable.delete()
    • UsersTable.get_user()
    • UsersTable.records()
    • UsersTable.usernames()
    • UsersTable.users()
    • UsersTable.is_user_registered()
    • UsersTable.is_password_valid()
    • UsersTable.is_admin()
  • convert_datetime()
• msl.network.json
  • Package
    • Package.BUILTIN
    • Package.JSON
    • Package.ULTRA
    • Package.UJSON
    • Package.RAPID
    • Package.RAPIDJSON
    • Package.SIMPLE
    • Package.SIMPLEJSON
    • Package.OR
    • Package.ORJSON
  • use()
  • serialize()
  • deserialize()
• msl.network.manager
  • Manager
    • Manager.acquire_lock()
    • Manager.new_connection()
    • Manager.check_user()
    • Manager.check_manager_password()
    • Manager.check_identity()
    • Manager.get_handshake_data()
    • Manager.handler()
    • Manager.release_lock()
    • Manager.remove_peer()
    • Manager.close_writer()
    • Manager.shutdown_manager()
    • Manager.identity()
    • Manager.link()
    • Manager.unlink()
    • Manager.write_request()
  • Peer
  • run_forever()
  • run_services()
  • filter_run_forever_kwargs()
• msl.network.network
  • Network
    • Network.identity()
    • Network.set_logging_level()
  • Device
    • Device.address_manager
    • Device.loop_thread_id
    • Device.name
    • Device.port
    • Device.add_tasks()
    • Device.shutdown_handler()
• msl.network.service
  • Service
    • Service.max_clients
    • Service.emit_notification()
    • Service.emit_notification_threadsafe()
    • Service.ignore_attributes()
    • Service.start()
  • filter_service_start_kwargs()
• msl.network.ssh
  • parse_console_script_kwargs()
  • start_manager()
  • connect()
  • exec_command()
• msl.network.utils
  • ensure_root_path()
  • parse_terminal_input()