:py:mod:`vspyx.RPC`
===================

.. py:module:: vspyx.RPC


Package Contents
----------------

Classes
~~~~~~~

.. autoapisummary::

   vspyx.RPC.Module
   vspyx.RPC.Service




.. py:class:: Module

   Bases: :py:obj:`vspyx.Core.Module`

   .. autoapi-inheritance-diagram:: vspyx.RPC.Module
      :parts: 1
      :private-bases:

   Module
           

   .. py:method:: AddService(self, service: Service) -> Any

      Adds a service to the RPC server. The service will be
      served on the next invocation of Start()

      :Parameter service: the service to add



   .. py:method:: ClearServices(self) -> Any

      Clears all services from the RPC server. If the server is already
      running the services won't be removed until Stop() is called.



   .. py:method:: RemoveService(self, service: Service) -> Any

      Removes a service from the RPC server. If the server is already
      running the service won't be removed until Stop() is called.

      :Parameter service: the service to remove



   .. py:method:: Start(self, listenSpec: str) -> Any

      Start the RPC server in insecure mode with all services that have been
      added up to the point of the call.

      :Parameter listenSpec: , iface:port specification to listen for incoming connections, for example localhost:19870 or 0.0.0.0:19870



   .. py:method:: StartSecure(self, listenSpec: str, privateKeyPem: str, fullCertChainPem: str, secretToken: str) -> Any

      Start the RPC server in secure mode with all services that have been
      added up to the point of the call.

      :Parameter listenSpec: , iface:port specification to listen for incoming connections, for example localhost:19870 or 0.0.0.0:19870
      :Parameter privateKeyPem: path to the private key .pem file
      :Parameter fullCertChainPem: path to the certificate chain .pem file
      :Parameter secretToken: a secret token that must every client must provide. sent as x-intrepidcs-walrus-token auth metadata



   .. py:method:: Stop(self) -> Any

      Stop the RPC server

                      



.. py:class:: Service

   Bases: :py:obj:`vspyx.Core.Object`

   .. autoapi-inheritance-diagram:: vspyx.RPC.Service
      :parts: 1
      :private-bases:

   Service
           

   .. py:method:: Shutdown(self) -> Any