Struct Publisher

pub(crate) struct Publisher<R: Runtime, M: Mockable> {
    runtime: R,
    nickname: HsNickname,
    dir_provider: Arc<dyn NetDirProvider>,
    mockable: M,
    config: Arc<OnionServiceConfig>,
    ipt_watcher: IptsPublisherView,
    config_rx: Receiver<Arc<OnionServiceConfig>>,
    keymgr: Arc<KeyMgr>,
    status_tx: PublisherStatusSender,
    path_resolver: Arc<CfgPathResolver>,
}

A handle for the Hsdir Publisher for an onion service.

This handle represents a set of tasks that identify the hsdirs for each relevant time period, construct descriptors, publish them, and keep them up-to-date.

Fields

runtime: R

The runtime.

nickname: HsNickname

The service for which we’re publishing descriptors.

dir_provider: Arc<dyn NetDirProvider>

A source for new network directories that we use to determine our HsDirs.

mockable: M

Mockable state.

This is used for launching circuits and for obtaining random number generators.

config: Arc<OnionServiceConfig>

The onion service config.

ipt_watcher: IptsPublisherView

A channel for receiving IPT change notifications.

config_rx: Receiver<Arc<OnionServiceConfig>>

A channel for receiving onion service config change notifications.

keymgr: Arc<KeyMgr>

The key manager.

status_tx: PublisherStatusSender

A sender for updating the status of the onion service.

path_resolver: Arc<CfgPathResolver>

Path resolver for configuration files.

Implementations

impl<R: Runtime, M: Mockable> Publisher<R, M>

pub(crate) fn new( runtime: R, nickname: HsNickname, dir_provider: Arc<dyn NetDirProvider>, mockable: impl Into<M>, ipt_watcher: IptsPublisherView, config_rx: Receiver<Arc<OnionServiceConfig>>, status_tx: PublisherStatusSender, keymgr: Arc<KeyMgr>, path_resolver: Arc<CfgPathResolver>, ) -> Self

Create a new publisher.

When it launches, it will know no keys or introduction points, and will therefore not upload any descriptors.

The publisher won’t start publishing until you call Publisher::launch.

pub(crate) fn launch(self) -> Result<(), StartupError>

Launch the publisher reactor.