Skip to content

Commit

Permalink
Update private docs for ClientOptions
Browse files Browse the repository at this point in the history
  • Loading branch information
rustworthy committed Apr 22, 2024
1 parent f8d3f32 commit e9cd581
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions src/proto/client/options.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,32 @@ use crate::proto::WorkerId;

#[derive(Clone, Debug)]
pub(crate) struct ClientOptions {
// Hostname to advertise to server. Defaults to machine hostname.
/// Hostname to advertise to server.
///
/// Defaults to machine hostname.
pub(crate) hostname: Option<String>,

// PID to advertise to server. Defaults to process ID.
/// PID to advertise to server.
///
/// Defaults to process ID.
pub(crate) pid: Option<usize>,

// Worker ID to advertise to server Defaults to a GUID.
/// Worker ID to advertise to server.
///
/// Defaults to a GUID.
pub(crate) wid: Option<WorkerId>,

// Labels to advertise to server. Defaults to ["rust"].
/// Labels to advertise to server.
///
/// Defaults to ["rust"].
pub(crate) labels: Vec<String>,

// Password to authenticate with. Defaults to None.
/// Password to authenticate with.
///
/// Defaults to None.
pub(crate) password: Option<String>,

// Whether this client is instatianted for a worker (i.e. to consume jobs).
/// Whether this client is instatianted for a worker (i.e. to consume jobs).
pub(crate) is_worker: bool,
}

Expand Down

0 comments on commit e9cd581

Please sign in to comment.