Msl-network

==============================

==========================

- Added

* a :class:`~msl.network.client.Link` can create an exclusive or shared lock
with a :class:`~msl.network.service.Service`
* add :attr:`~msl.network.client.Link.service_max_clients` property to a
:class:`~msl.network.client.Link` and
:class:`~msl.network.client.LinkedClient`
* the :attr:`~msl.network.network.Device.loop_thread_id` property for a
:class:`~msl.network.service.Service` and a :class:`~msl.network.client.Client`
* the :meth:`~msl.network.service.Service.emit_notification_threadsafe` method
for a :class:`~msl.network.service.Service`
* ability to specify the `host` to use when starting a :class:`~msl.network.manager.Manager`
* support for Python 3.9, 3.10 and 3.11
* :func:`~msl.network.network.Network.set_logging_level` to be able to set the
logging level at runtime
* ability to add tasks to the event loop via the
:meth:`~msl.network.network.Device.add_tasks` method
* the :meth:`~msl.network.network.Device.shutdown_handler` method is called
after the connection to the :class:`~msl.network.manager.Manager` is lost
but before the event loop stops
* ability to use all :class:`~msl.network.database.Database` classes as a
context manager (i.e., using a `with` statement)
* the ``--log-level`` flag to the ``start`` command
* the ``delete`` command-line argument to delete files that are created by MSL-Network
* `orjson <https://pypi.org/project/orjson/>`_ as a JSON backend to
:class:`~msl.network.json.Package`
* ``JSON``, ``UJSON``, ``RAPIDJSON`` and ``SIMPLEJSON`` are aliases
for the JSON backends in :class:`~msl.network.json.Package`
* the ``read_limit`` keyword arguments to
:func:`~msl.network.client.connect` and
:meth:`~msl.network.service.Service.start`
* the ``auto_save`` keyword argument to :func:`~msl.network.client.connect`
and :func:`~msl.network.cryptography.get_ssl_context`
* the ``digest_size`` keyword argument to
:func:`~msl.network.cryptography.generate_certificate` and
:func:`~msl.network.cryptography.get_fingerprint`
* the ``name`` and ``extensions`` keyword arguments to
:func:`~msl.network.cryptography.generate_certificate`,
* ``**kwargs`` to :func:`~msl.network.cryptography.get_ssl_context`

- Changed

* the `result` object that is returned by a :class:`~msl.network.service.Service`
response can implement a callable ``to_json()`` method
* the value of the ``algorithm`` keyword argument in
:func:`~msl.network.cryptography.get_fingerprint`
can now also be of type :class:`str`
* renamed ``uuid`` to be ``uid`` in the JSON format
* making an asynchronous request now returns a :class:`concurrent.futures.Future` instance
instead of an :class:`asyncio.Future` instance
* :class:`~msl.network.client.Client` and :class:`~msl.network.service.Service`
are subclasses of :class:`~msl.network.network.Device`
* move the ``utils.localhost_aliases`` function to be defined as
:attr:`~msl.network.constants.LOCALHOST_ALIASES`
* renamed the ``Client.manager`` method to :meth:`~msl.network.client.Client.identities`
* renamed ``certfile`` to ``cert_file`` in :func:`~msl.network.client.connect`,
:meth:`~msl.network.service.Service.start`
and :func:`~msl.network.cryptography.get_ssl_context`
* can now change which JSON backend to use during runtime by calling the
:func:`~msl.network.json.use` function
* moved the ``msl.network.constants.JSONPackage`` class to
:class:`msl.network.json.Package`
* renamed the command line arguments ``--certfile`` to ``--cert-file``,
``--keyfile`` to ``--key-file``, ``--keyfile-password`` to ``--key-file-password``,
and ``--logfile`` to ``--log-file`` for the ``start`` command
* use ``T`` as the separator between the date and time in
a :class:`~msl.network.database.ConnectionsTable`
* rename the keyword arguments ``timestamp1`` to ``start`` and ``timestamp2``
to ``end`` in :meth:`~msl.network.database.ConnectionsTable.connections`
* the default filename for the certificate and key files now use ``'localhost'``
instead of the value of `HOSTNAME`

- Fixed

* an ``AttributeError`` could be raised when generating the identity of a
:class:`~msl.network.service.Service`
* can now handle multiple requests/replies contained within the same network
packet

- Removed

* Support for Python 3.5
* the ``MSLNetworkError`` exception class (a :exc:`RuntimeError` is raised instead)
* the ``Service.set_debug`` method
* the ``termination`` and ``encoding`` class attributes of
:class:`~msl.network.network.Network`
* the ``send_pending_requests``, ``raise_latest_error`` and ``wait``
methods of a :class:`~msl.network.client.Client`
* the ``--debug`` flag from the ``start`` command
* the ``utils.new_selector_event_loop`` function
* the ``constants.JSON`` attribute
* `YAJL <https://pypi.org/project/yajl/>`_ as a JSON backend option

==========================

- Added

* support for Python 3.8
* the `utils.new_selector_event_loop` function to create a new `asyncio.SelectorEventLoop`
* the ``--logfile`` command line argument for the `start` command
* a `Service` can emit notifications to all `Clients` that are linked with it
* a `Service` now accepts an `ignore_attributes` keyword argument when it is instantiated
and also has an `ignore_attributes` method
* a `Link` can unlink from a `Service`
* the `LinkedClient.client` property
* ``1.0.0.127.in-addr.arpa`` as a localhost alias

- Changed

* use ``__package__`` as the logger name
* the `FileHandler` and `StreamHandler` that are added to the root logger now use a
decimal point instead of a comma between the seconds and milliseconds values
* renamed the `disconnect_service` method for a `Link` and a `Service`
(which was added in version 0.4.0) to be `shutdown_service`

- Removed

* the `Service._shutdown` method since it is no longer necessary to call this method
from the `Service` subclass because shutting down happens automatically behind the scenes

==========================

- Added

* ``1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.ip6.arpa`` as a localhost alias

- Changed

* calling the `Client.manager(as_string=True)` method now prints the attributes
analogous to how a `Client` would call the method of a `Service`

- Fixed

* the `timeout` value for creating a `LinkedClient` is now the total time that it
takes to connect to the Network `Manager` plus the time required to link with the
`Service` (this fixes a race condition when starting a `Service` on a remote
computer and then trying to link to the same `Service`)

==========================

- Added

* the `ssh` module
* a `LinkedClient` class
* the `run_forever` (to start the `Manager`) and the `run_services` (to start the `Manager`
and then start the `Service`\s) functions
* the `filter_service_start_kwargs`, `filter_run_forever_kwargs` and
`filter_client_connect_kwargs` functions
* a `disconnect_service` method to `Link`
* shorter argument name options for some CLI parameters
* a `Service` now accepts `name` and `max_clients` as keyword arguments when it is instantiated

- Changed

* the following CLI changes to argument names for the `certgen` command

+ ``--key-path`` became ``--keyfile``
+ ``--key-password`` became ``--keyfile-password``

* the following CLI changes to argument names for the `keygen` command

+ ``--path`` became ``--out``

* the following CLI changes to argument names for the `start` command

+ ``--cert`` became ``--certfile``
+ ``--key`` became ``--keyfile``
+ ``--key-password`` became ``--keyfile-password``

* the `certificate` keyword argument for the `connect` and `get_ssl_context` functions and
for the `Service.start` method was changed to `certfile`
* the `as_yaml` keyword argument for the `Client.manager` method was changed to `as_string`
* a `Client` can no longer request a private attribute -- i.e., an attribute that starts with
a ``_`` (an underscore) -- from a `Service`
* the default `timeout` value for connecting to the `Manager` is now 10 seconds

- Fixed

* perform error handling if the `Manager` attempts to start on a port that is already in use
* issue `7 <https://github.com/MSLNZ/msl-network/issues/7>`_ - a `Service` can now specify
the maximum number of `Client`\s that can be linked with it
* issue `6 <https://github.com/MSLNZ/msl-network/issues/6>`_ - the `password_manager` keyword
argument is now used properly when starting a `Service`

- Removed

* the `name` class attribute for a `Service`
* the `send_request` method for a `Client` (must link with a `Service`)

==========================

- Added

* every request from a `Client` can now specify a timeout value
* the docs now include an example for how to send requests to the ``Echo`` `Service`

- Changed

* the default `timeout` value for connecting to the `Manager` is now 10 seconds
* the `__repr__` method for a `Client` no longer includes the id as a hex number

- Fixed

* issue `5 <https://github.com/MSLNZ/msl-network/issues/5>`_
* issue `4 <https://github.com/MSLNZ/msl-network/issues/4>`_
* issue `3 <https://github.com/MSLNZ/msl-network/issues/3>`_
* issue `2 <https://github.com/MSLNZ/msl-network/issues/2>`_
* issue `1 <https://github.com/MSLNZ/msl-network/issues/1>`_

- Removed

* the `__repr__` method for a `Service`