callbacks.h

// Copyright (c) 2014-2026 Savoir-faire Linux Inc.
// SPDX-License-Identifier: MIT
#pragma once
 
#include "infohash.h"
#include "value.h"
 
#include <vector>
#include <memory>
#include <functional>
#include <string>
 
#ifdef OPENDHT_JSONCPP
#include <json/json.h>
#endif
 
namespace dht {
 
struct Node;

enum class NodeStatus {
    Disconnected, // 0 nodes
    Connecting,   // 1+ nodes
    Connected     // 1+ good nodes
};
 
inline constexpr const char*
statusToStr(NodeStatus status)
{
    return status == NodeStatus::Connected ? "connected"
                                           : (status == NodeStatus::Connecting ? "connecting" : "disconnected");
}
 
struct OPENDHT_PUBLIC NodeStats
{
    unsigned good_nodes {0}, dubious_nodes {0}, cached_nodes {0}, incoming_nodes {0};
    unsigned table_depth {0};
    unsigned searches {0};
    unsigned node_cache_size {0};
    unsigned getKnownNodes() const { return good_nodes + dubious_nodes; }
    unsigned long getNetworkSizeEstimation() const { return 8 * std::exp2(table_depth); }
    std::string toString() const;
 
#ifdef OPENDHT_JSONCPP
    Json::Value toJson() const;
    NodeStats() {};
    explicit NodeStats(const Json::Value& v);
#endif
 
    MSGPACK_DEFINE_MAP(good_nodes, dubious_nodes, cached_nodes, incoming_nodes, table_depth, searches, node_cache_size)
};
 
struct OPENDHT_PUBLIC NodeInfo
{
    InfoHash id;
    InfoHash node_id;
    NodeStats ipv4 {};
    NodeStats ipv6 {};
    size_t ongoing_ops {0};
    size_t storage_values {0};
    size_t storage_size {0};
    size_t local_storage_values {0};
    size_t local_storage_size {0};
    in_port_t bound4 {0};
    in_port_t bound6 {0};
 
#ifdef OPENDHT_JSONCPP
    Json::Value toJson() const;
    NodeInfo() {};
    explicit NodeInfo(const Json::Value& v);
#endif
 
    MSGPACK_DEFINE_MAP(id,
                       node_id,
                       ipv4,
                       ipv6,
                       ongoing_ops,
                       storage_values,
                       storage_size,
                       local_storage_values,
                       local_storage_size,
                       bound4,
                       bound6)
};

struct OPENDHT_PUBLIC Config
{
    InfoHash node_id {};

    NetId network {0};

    bool is_bootstrap {false};

    bool maintain_storage {false};

    std::string persist_path {};

    ssize_t max_req_per_sec {0};

    ssize_t max_peer_req_per_sec {0};
 
    /* If non-0, overrides the default maximum number of searches. -1 means no limit.  */
    ssize_t max_searches {0};
 
    /* If non-0, overrides the default maximum store size for remote values. -1 means no limit.  */
    ssize_t max_store_size {0};
 
    /* If non-0, overrides the default maximum store size for locally stored values. -1 means no limit.  */
    ssize_t max_local_store_size {0};
 
    /* If non-0, overrides the default maximum store key count. -1 means no limit.  */
    ssize_t max_store_keys {0};

    bool public_stable {false};
 
    /* Client mode, node will not be used by other nodes to store data. */
    bool client_mode {false};
};

struct OPENDHT_PUBLIC SecureDhtConfig
{
    Config node_config {};
    crypto::Identity id {};

    bool cert_cache_all {false};
};
 
enum class OPENDHT_PUBLIC PushNotificationResult : uint8_t {
    /* success codes */
    PutRefresh,
    ListenRefresh,
    Values,
    ValuesExpired,
    /* ignored/error codes */
    IgnoredWrongSession = 0x80,
    IgnoredNoOp,
    IgnoredStopped,
    IgnoredDisabled,
    Error
};
 
static constexpr size_t STORAGE_LIMIT_DEFAULT {1024 * 1024 * 64};
static constexpr size_t STORAGE_LIMIT_UNLIMITED {(size_t) -1};
 
using ValuesExport = std::pair<InfoHash, Blob>;
 
using QueryCallback = std::function<bool(const std::vector<std::shared_ptr<FieldValueIndex>>& fields)>;
using GetCallback = std::function<bool(const std::vector<std::shared_ptr<Value>>& values)>;
using ValueCallback = std::function<bool(const std::vector<std::shared_ptr<Value>>& values, bool expired)>;
using GetCallbackSimple = std::function<bool(std::shared_ptr<Value> value)>;
using ShutdownCallback = std::function<void()>;
using IdentityAnnouncedCb = std::function<void(bool)>;
using PublicAddressChangedCb = std::function<void(std::vector<SockAddr>)>;
 
using CertificateStoreQueryLegacy
    = std::function<std::vector<std::shared_ptr<crypto::Certificate>>(const InfoHash& pk_id)>;
using CertificateStoreQuery = std::function<std::vector<std::shared_ptr<crypto::Certificate>>(const PkId& pk_id)>;
 
using DoneCallback = std::function<void(bool success, const std::vector<std::shared_ptr<Node>>& nodes)>;
using DoneCallbackSimple = std::function<void(bool success)>;
 
typedef bool (*GetCallbackRaw)(std::shared_ptr<Value>, void* user_data);
typedef bool (*ValueCallbackRaw)(std::shared_ptr<Value>, bool expired, void* user_data);
typedef void (*DoneCallbackRaw)(bool, std::vector<std::shared_ptr<Node>>*, void* user_data);
typedef void (*ShutdownCallbackRaw)(void* user_data);
typedef void (*DoneCallbackSimpleRaw)(bool, void* user_data);
typedef bool (*FilterRaw)(const Value&, void* user_data);
 
OPENDHT_PUBLIC GetCallbackSimple bindGetCb(GetCallbackRaw raw_cb, void* user_data);
OPENDHT_PUBLIC GetCallback bindGetCb(GetCallbackSimple cb);
OPENDHT_PUBLIC ValueCallback bindValueCb(ValueCallbackRaw raw_cb, void* user_data);
OPENDHT_PUBLIC ShutdownCallback bindShutdownCb(ShutdownCallbackRaw shutdown_cb_raw, void* user_data);
OPENDHT_PUBLIC DoneCallback bindDoneCb(DoneCallbackSimple donecb);
OPENDHT_PUBLIC DoneCallback bindDoneCb(DoneCallbackRaw raw_cb, void* user_data);
OPENDHT_PUBLIC DoneCallbackSimple bindDoneCbSimple(DoneCallbackSimpleRaw raw_cb, void* user_data);
OPENDHT_PUBLIC Value::Filter bindFilterRaw(FilterRaw raw_filter, void* user_data);
 
} // namespace dht