.. _protocols_srp_classes_srpV3:

=====
SrpV3
=====

`rogue::protocols::srp::SrpV3` bridges Rogue memory transactions to SRPv3
stream frames that are transported to hardware SRP endpoints.
For conceptual guidance, see :doc:`/built_in_modules/protocols/srp/srpV3`.

For SRPv3 packet-level protocol details, see:

- Https://confluence.slac.stanford.edu/x/cRmVD

Threading and locking summary
=============================

- ``doTransaction()`` and ``acceptFrame()`` may run in different contexts.
- In-flight map access is managed by base memory-slave synchronization.
- Per-transaction payload access is guarded via transaction locking.

Python binding
--------------

This C++ class is also exported into Python as ``rogue.protocols.srp.SrpV3``.

Python API page:
- :doc:`/api/python/rogue/protocols/srp/srpv3`

objects in C++ are referenced by the following shared pointer typedef:

.. doxygentypedef:: rogue::protocols::srp::SrpV3Ptr

The class description is shown below:

.. doxygenclass:: rogue::protocols::srp::SrpV3
   :members: