# Functions
RequestEcho method wraps the entire API connection logic to obtain an object of type EchoResponse to check for connection to a qpep server.
RequestStatistics method wraps the entire API connection logic to obtain an object of type StatsInfoResponse to obtain info about an host from a qpep server.
RequestStatus method wraps the entire API connection logic to obtain an object of type StatusResponse to query the current status of a server.
RunServer method initializes a new api server (on an external or local ip), stoppable by using the provided context and cancel function.
# Constants
API_ECHO_PATH path of the echo api.
API_PREFIX_SERVER string prefix of client apis.
API_PREFIX_SERVER string prefix of server apis.
API_STATS_DATA_PATH path of the generic statistics data api.
API_STATS_DATA_SRV_PATH path of the statistics data api for a certain host.
API_STATS_HOSTS_PATH path of the hosts list api.
API_STATS_INFO_PATH path of the generic statistics info api.
API_STATS_INFO_SRV_PATH path of the statistics info api for a certain host.
API_ECHO_PATH path of the status api.
API_ECHO_PATH path of the versions api.
INFO_ADDRESS address being sent to the client.
INFO_OTHER_VERSION version of the software on the other end of the connection.
INFO_PLATFORM platform used by the client, as communicated in api echo.
INFO_UPDATE last time the server received an echo from the client.
No description provided by the author
PERF_CONN number of current connections for a particular client.
PERF_DW_COUNT current download speed for a particular client.
PERF_DW_SPEED current download speed for a particular client.
PERF_DW_TOTAL total number of bytes downloaded by a particular client.
PERF_UP_COUNT current upload speed for a particular client.
PERF_UP_SPEED current upload speed for a particular client.
PERF_UP_TOTAL total number of bytes uploaded by a particular client.
TOTAL_CONNECTIONS total connections open on the server at this time.
# Variables
Statistics global variable to act on statistics kept by the system.
# Structs
StatsInfo models a single statistics info tracked by the server/client.
APIRouter struct that encapsulates the registered paths to be served.
EchoResponse models the response to the "/echo" api and allows to check the vitality of connections to server.
StatsInfo models a single statistics info tracked by the server/client.
StatsInfoResponse models the list of statistics being served to an api client.
StatusResponse models the current status of the server.
VersionsResponse models the response to "/versions" api.