Struct tor_hsservice::OnionService

pub struct OnionService { /* private fields */ }

A handle to an instance of an onion service, which may or may not be running.

To construct an OnionService, call OnionService::new. It will not start handling requests until you call its .launch() method.

Implementations

impl OnionService

pub fn new( config: OnionServiceConfig, keymgr: Arc<KeyMgr>, state_dir: &StateDirectory ) -> Result<Self, StartupError>

Create (but do not launch) a new onion service.

The onion service’s behavior and local nickname will be determined by the provided configuration.

The onion service’s keys will be kept in keymgr. Its non-key state information will be stored persistently in a location and manner controlled by state_dir.

pub fn launch<R>( self, runtime: R, netdir_provider: Arc<dyn NetDirProvider>, circ_pool: Arc<HsCircPool<R>> ) -> Result<(Arc<RunningOnionService>, impl Stream<Item = RendRequest>), StartupError>

where R: Runtime,

Tell this onion service to begin running, and return a RunningOnionService and its stream of rendezvous requests.

You can turn the resulting stream into a stream of StreamRequest using the handle_rend_requests helper function.

Once the RunningOnionService is dropped, the onion service will stop publishing, and stop accepting new introduction requests. Existing streams and rendezvous circuits will remain open.

pub fn onion_name(&self) -> Option<HsId>

Return the onion address of this service.

Clients must know the service’s onion address in order to discover or connect to it.

Returns None if the HsId of the service could not be found in any of the configured keystores.