:py:mod:`pywebui.tcpip.services`
================================

.. py:module:: pywebui.tcpip.services


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   pywebui.tcpip.services.Service
   pywebui.tcpip.services.ServiceMethods




.. py:class:: Service(attrs)



   Host object.

   .. attribute:: address

      the IP address of service.

      :type: str

   .. attribute:: name

      the name of service.

      :type: str

   .. attribute:: port

      the listening port.

      :type: int

   .. attribute:: process

      the name of process for current service.

      :type: str

   .. attribute:: protocols

      (list(str)): the array of service protocols

   .. attribute:: state

      the state of service.

      :type: str


.. py:class:: ServiceMethods

   Encapsulates methods for manage services.

   .. py:method:: get_services(self) -> List[Service]

      Returns list of services.


   .. py:method:: get_service(self, name) -> Service

      Returns the details of selected service.


   .. py:method:: add_service(self, name: str, process: str, port: int, username: str, file: str) -> bool

      Creates the new service.


   .. py:method:: edit_service(self, name, **kwds) -> bool

      Edits the selected service.

      Service parameters available for modification described in Edit Service API documentation.


   .. py:method:: delete_service(self, name: str) -> bool

      Delete service.