#include <relay_service.h>

Inheritance diagram for librats::RelayService:

Public Member Functions
virtual	~RelayService ()=default
virtual bool	connect_via_relay (const PeerId &target)=0
	Try to reach target through a node both ends are connected to.
virtual bool	serves (const PeerId &) const
	Whether peer said it carries circuits for others — a node to try first for anything relayed, a punch's rendezvous included.

Detailed Description

Definition at line 31 of file relay_service.h.

Constructor & Destructor Documentation

◆ ~RelayService()

virtual librats::RelayService::~RelayService ( )

virtualdefault

Member Function Documentation

◆ connect_via_relay()

virtual bool librats::RelayService::connect_via_relay ( const PeerId & target )

pure virtual

Try to reach target through a node both ends are connected to.

Non-blocking; success surfaces as an ordinary peer-connected event, and the resulting peer is ordinary in every way except that its bytes take a detour (PeerInfo::transport is TransportKind::Relay).

Returns: whether an attempt actually started — false is routine (already connected, an attempt is already running, the target is in cooldown, or this node has no peer that could carry the circuit) and needs no handling by the caller.

Implemented in librats::Relay.

◆ serves()

virtual bool librats::RelayService::serves ( const PeerId & ) const

inlinevirtual

Whether peer said it carries circuits for others — a node to try first for anything relayed, a punch's rendezvous included.

Reimplemented in librats::Relay.

Definition at line 47 of file relay_service.h.

The documentation for this struct was generated from the following file:

librats/subsystems/relay_service.h

Public Member Functions