circuit_service.h

Go to the documentation of this file.

#pragma once

 
#include "librats/core/types.h"
#include "librats/peer/peer_id.h"
#include "librats/peer/peer_table.h"   // PeerRoute
#include "librats/transport/link.h"
#include "librats/transport/relay_link.h"   // ForwardedCircuit
 
#include <atomic>
#include <cstdint>
#include <memory>
#include <optional>
 
namespace librats {
 
class CircuitService {
public:
    virtual ~CircuitService() = default;

    virtual std::optional<PeerRoute> adopt_circuit(const PeerId& carrier,
                                                   std::unique_ptr<Link> link,
                                                   ConnRole role, bool connected) = 0;

    virtual void wake_circuit(PeerRoute route, uint32_t events) = 0;

    virtual void close_circuit(PeerRoute route, CloseReason reason) = 0;
 
    // — circuits whose relay forwards datagrams —
    //
    // `cid` is the dialer's (even) half of the connection id pair the relay chose.
    // Each returns nullopt / false when the carrier is not a peer reached over UDP
    // — the circuit is then ended — and otherwise reports failures that only the
    // reactor can see by ending the circuit too.

    virtual std::optional<PeerRoute> dial_relayed(const PeerId& carrier, uint64_t cid,
                                                  ForwardedCircuit circuit) = 0;

    virtual std::optional<PeerRoute> expect_relayed(const PeerId& carrier, uint64_t cid,
                                                    ForwardedCircuit circuit) = 0;

    virtual bool forward_datagrams(const PeerId& dialer, const PeerId& responder, uint64_t cid,
                                   std::shared_ptr<std::atomic<uint64_t>> bytes, uint64_t rate,
                                   uint64_t burst) = 0;
    virtual void stop_forwarding(uint64_t cid) = 0;
};
 
} // namespace librats