network_clicks.hpp

Go to the documentation of this file.

 
#ifndef LSH_CORE_CORE_NETWORK_CLICKS_HPP
#define LSH_CORE_CORE_NETWORK_CLICKS_HPP
 
#include <stdint.h>
 
#include "util/constants/click_types.hpp"
namespace NetworkClicks
{
enum class RequestResult : uint8_t
{
    Accepted,          
    AlreadyPending,    
    TransportRejected  
};
 
// Network clicks
[[nodiscard]] auto request(uint8_t clickableIndex, constants::ClickType clickType)
    -> RequestResult;  // Initiates a network click action and reports whether the transaction was accepted, already pending, or rejected.
[[nodiscard]] auto confirm(uint8_t clickableIndex, constants::ClickType clickType)
    -> bool;  // Confirms a pending network click action after receiving an ACK
[[nodiscard]] auto matchesCorrelationId(uint8_t clickableIndex, constants::ClickType clickType, uint8_t correlationId)
    -> bool;                                               // Returns true if the active click matches the given correlation ID.
[[nodiscard]] auto thereAreActiveNetworkClicks() -> bool;  // Returns if there are active stored network clicks
void eraseNetworkClick(uint8_t clickableIndex, constants::ClickType clickType);  // Erase a stored network click
[[nodiscard]] auto isNetworkClickExpired(uint8_t clickableIndex, constants::ClickType clickType)
    -> bool;  // Returns true if the pending network click has expired or is no longer active.
[[nodiscard]] auto checkNetworkClickTimer(uint8_t clickableIndex, constants::ClickType clickType, bool failover)
    -> bool;  // Checks one pending network click and runs local fallback when it expires or failover is forced.
[[nodiscard]] auto checkAllNetworkClicksTimers(bool failover)
    -> bool;  // Checks all pending network clicks and runs local fallbacks for expired or forced entries.
}  // namespace NetworkClicks
 
#endif  // LSH_CORE_CORE_NETWORK_CLICKS_HPP