caproto.server.stats.PeriodicStatusHelper
=========================================


.. currentmodule:: caproto.server.stats

.. autoclass:: PeriodicStatusHelper

    .. if not using autodoc, add this here: automethod:: __init__

    

    

    
    
    .. list-table:: PeriodicStatusHelper pvproperties
        :header-rows: 1
        :widths: auto

        *  - Attribute
           - Suffix
           - Docs
           - Type
           - Notes
           - Alarm Group
    
        *  - access
           - ``ACCESS``
           - CA Security access level to this IOC
           - ENUM (:class:`mbbo <caproto.server.records.MbboFields>`)
           - 
           - 
    
        *  - ca_client_count
           - ``CA_CLNT_CNT``
           - Number of CA clients [not implemented]
           - int (:class:`longin <caproto.server.records.LonginFields>`)
           - 
                 **Read-only**
           - 
    
        *  - ca_connection_count
           - ``CA_CONN_CNT``
           - Number of CA Connections [not implemented]
           - int (:class:`longin <caproto.server.records.LonginFields>`)
           - 
                 **Read-only**
           - 
    
        *  - fd_count
           - ``FD_CNT``
           - Allocated File Descriptors
           - int (:class:`ai <caproto.server.records.AiFields>`)
           - 
                 **Read-only**
           - 
    
        *  - fd_free
           - ``FD_FREE``
           - Available FDs
           - int (:class:`calc <caproto.server.records.CalcFields>`)
           - 
                 **Read-only**
           - 
    
        *  - fd_max
           - ``FD_MAX``
           - Max File Descriptors
           - int (:class:`ai <caproto.server.records.AiFields>`)
           - 
                 **Read-only**
           - 
    
        *  - heartbeat
           - ``HEARTBEAT``
           - 1 Hz counter since startup
           - int (:class:`calcout <caproto.server.records.CalcoutFields>`)
           - 
                 **Read-only**
                 **Startup**
           - 
    
        *  - ioc_cpu_load
           - ``IOC_CPU_LOAD``
           - 
           - float (:class:`ai <caproto.server.records.AiFields>`)
           - 
                 **Read-only**
           - 
    
        *  - mem_free
           - ``MEM_FREE``
           - Memory free (including swap).
           - int (:class:`ai <caproto.server.records.AiFields>`)
           - 
                 **Read-only**
           - 
    
        *  - mem_max
           - ``MEM_MAX``
           - 
           - int (:class:`ai <caproto.server.records.AiFields>`)
           - 
                 **Read-only**
           - 
    
        *  - mem_used
           - ``MEM_USED``
           - Memory used.
           - int (:class:`ai <caproto.server.records.AiFields>`)
           - 
                 **Read-only**
           - 
    
        *  - num_threads
           - ``NumThreads``
           - Number of threads in use
           - int (:class:`longin <caproto.server.records.LonginFields>`)
           - 
                 **Read-only**
           - 
    
        *  - record_count
           - ``RECORD_CNT``
           - Number of records
           - int (:class:`ai <caproto.server.records.AiFields>`)
           - 
                 **Read-only**
           - 
    
        *  - start_count
           - ``START_CNT``
           - Startup count, if autosave is working
           - int (:class:`calcout <caproto.server.records.CalcoutFields>`)
           - 
                 **Read-only**
                 **Startup**
           - 
    
        *  - start_tod
           - ``STARTTOD``
           - Time and date of startup
           - str (:class:`stringin <caproto.server.records.StringinFields>`)
           - 
                 **Read-only**
                 Length(100)
                 **Startup**
           - 
    
        *  - susp_task_count
           - ``SUSP_TASK_CNT``
           - Number of Suspended Tasks [not implemented]
           - int (:class:`longin <caproto.server.records.LonginFields>`)
           - 
                 **Read-only**
           - 
    
        *  - sys_cpu_load
           - ``SYS_CPU_LOAD``
           - CPU load
           - float (:class:`ai <caproto.server.records.AiFields>`)
           - 
                 **Read-only**
           - 
    
        *  - time_of_day
           - ``TOD``
           - Current time and date
           - str (:class:`stringin <caproto.server.records.StringinFields>`)
           - 
                 **Read-only**
                 Length(100)
                 **Startup**
           - 
    
        *  - update_period
           - ``UPD_TIME``
           - Basic stats update rate
           - float (:class:`ao <caproto.server.records.AoFields>`)
           - 
                 **Startup**
           - 
    
        *  - uptime
           - ``UPTIME``
           - Elapsed time since start
           - int (:class:`longin <caproto.server.records.LonginFields>`)
           - 
                 **Read-only**
           - 
    
    

    
    

    
    
    .. rubric:: Methods

    .. autosummary::
    
       ~PeriodicStatusHelper.group_read
       ~PeriodicStatusHelper.group_write
    
    

    
    
    .. rubric:: Attributes

    .. autosummary::

    
       ~PeriodicStatusHelper.default_values
       ~PeriodicStatusHelper.type_map
       ~PeriodicStatusHelper.type_map_read_only
    

    
    .. rubric:: pvproperty methods
    .. method:: heartbeat.startup(self, instance, async_lib)
        

    
    .. raw:: html

        <details>
        <summary>Source code: heartbeat.startup</summary>

    
    .. literalinclude:: /../../../../../miniconda/envs/test_env/lib/python3.7/site-packages/caproto/server/server.py
        :language: python
        :linenos:
        :dedent: 0
        :lineno-start: 766
        :lines: 766-795

    .. raw:: html

        </details>
        <br/>

    
    .. method:: start_count.startup(self, instance, async_lib)
        

    
    .. literalinclude:: /../../../../../miniconda/envs/test_env/lib/python3.7/site-packages/caproto/server/stats.py
        :language: python
        :linenos:
        :dedent: 4
        :lineno-start: 253
        :lines: 253-257
    .. method:: start_tod.startup(self, instance, async_lib)
        

    
    .. literalinclude:: /../../../../../miniconda/envs/test_env/lib/python3.7/site-packages/caproto/server/stats.py
        :language: python
        :linenos:
        :dedent: 4
        :lineno-start: 213
        :lines: 213-215
    .. method:: time_of_day.startup(self, instance, async_lib)
        

    
    .. raw:: html

        <details>
        <summary>Source code: time_of_day.startup</summary>

    
    .. literalinclude:: /../../../../../miniconda/envs/test_env/lib/python3.7/site-packages/caproto/server/server.py
        :language: python
        :linenos:
        :dedent: 0
        :lineno-start: 766
        :lines: 766-795

    .. raw:: html

        </details>
        <br/>

    
    .. method:: update_period.startup(self, instance, async_lib)
        

    
    .. raw:: html

        <details>
        <summary>Source code: update_period.startup</summary>

    
    .. literalinclude:: /../../../../../miniconda/envs/test_env/lib/python3.7/site-packages/caproto/server/stats.py
        :language: python
        :linenos:
        :dedent: 0
        :lineno-start: 423
        :lines: 423-438

    .. raw:: html

        </details>
        <br/>