titanfe.apps.control_peer.webapi.app module

Provide a RESTlike interface to manage the ControlPeer remotely

class titanfe.apps.control_peer.webapi.app.HelloWorld(*, message: str = 'Hello, World!')

Bases: pydantic.main.BaseModel

message: str

class titanfe.apps.control_peer.webapi.app.WebApi(control_peer)

Bases: object

Provide a RESTlike interface to manage the ControlPeer remotely

Parameters:

control_peer (ControlPeer) – an instance of the ControlPeer

Usage:

create an Instance of the WebAPI (glued together with FastAPI/Starlette and uvicorn) and use run to create an endlessly running asyncio task or use the serve coroutine to run it manually

property address

async serve()

serve the api using uvicorn

async stop()