Struct ClientBuilder

pub struct ClientBuilder<V: Client<16>> { /* private fields */ }

Builder for configuring a Client.

Implementations

impl<V: Client<16>> ClientBuilder<V>

pub fn new( task_id: TaskId, leader_aggregator_endpoint: Url, helper_aggregator_endpoint: Url, time_precision: Duration, vdaf: V, ) -> Self

Construct a ClientBuilder from its required DAP task parameters.

pub async fn build(self) -> Result<Client<V>, Error>

Finalize construction of a Client. This will fetch HPKE configurations from each aggregator via HTTPS.

pub fn build_with_hpke_configs( self, leader_hpke_config: HpkeConfig, helper_hpke_config: HpkeConfig, ) -> Result<Client<V>, Error>

👎Deprecated: Use ClientBuilder::with_leader_hpke_config, ClientBuilder::with_helper_hpke_config and ClientBuilder::build instead

Finalize construction of a Client, and provide aggregator HPKE configurations through an out-of-band mechanism.

Notes

This method is not compatible with OHTTP . Use ClientBuilder::with_ohttp_config and then ClientBuilder::build to provide OHTTP configuration.

pub fn with_http_client(self, http_client: Client) -> Self

Override the HTTPS client configuration to be used.

pub fn with_backoff( self, http_request_retry_parameters: ExponentialBackoff, ) -> Self

Override the exponential backoff parameters used when retrying HTTPS requests.

pub fn with_leader_hpke_config(self, hpke_config: HpkeConfig) -> Self

Set the leader HPKE configuration to be used, preventing the client from fetching it from the aggregator over HTTPS.

pub fn with_helper_hpke_config(self, hpke_config: HpkeConfig) -> Self

Set the helper HPKE configuration to be used, preventing the client from fetching it from the aggregator over HTTPS.

pub fn with_ohttp_config(self, ohttp_config: OhttpConfig) -> Self

Available on crate feature ohttp only.

Set the OHTTP configuration to be used when uploading reports, but not when fetching DAP HPKE configurations.

Examples

#[tokio::main]
async fn main() {
    let task_id = random();

    let client = janus_client::Client::builder(
        task_id,
        Url::parse("https://leader.example.com/").unwrap(),
        Url::parse("https://helper.example.com/").unwrap(),
        Duration::from_seconds(1),
        Prio3Count::new_count(2).unwrap(),
    )
    .with_ohttp_config(janus_client::OhttpConfig {
        key_configs: Url::parse("https://ohttp-keys.example.com").unwrap(),
        relay: Url::parse("https://ohttp-relay.example.com").unwrap(),
    })
    .build()
    .await
    .unwrap();

    client.upload(&true).await.unwrap();
}