Struct cometd_client::CometdClientBuilder

pub struct CometdClientBuilder<'a, 'b, 'c, 'd, 'e> { /* private fields */ }

A builder to construct CometdClient.

Implementations

impl<'a, 'b, 'c, 'd, 'e> CometdClientBuilder<'a, 'b, 'c, 'd, 'e>

pub fn new(endpoint: &'a Url) -> Self

Construct a new ClientBuilder.

pub fn build<Msg>(self) -> CometdResult<CometdClient<Msg>>where Msg: DeserializeOwned + Send + Sync + 'static,

Return a CometdClient.

Example

let client = CometdClientBuilder::new(&"http://[::1]:1025/notifications/".parse()?)
    .build()?;

pub const fn handshake_base_path(self, url: &'b str) -> Self

Set cometd server handshake url path.

Example

    let client = CometdClientBuilder::new(&"http://[::1]:1025/notifications/".parse()?)
        .handshake_base_path("hand/") // http://[::1]:1025/notifications/hand/handshake
        .build()?;

pub const fn subscribe_base_path(self, url: &'c str) -> Self

Set cometd server subscribe url path.

Example

    let client = CometdClientBuilder::new(&"http://[::1]:1025/notifications/".parse()?)
        .subscribe_base_path("sub/") // http://[::1]:1025/notifications/sub/
        .build()?;

pub const fn connect_base_path(self, url: &'d str) -> Self

Set cometd server connect url path.

Example

    let client = CometdClientBuilder::new(&"http://[::1]:1025/notifications/".parse()?)
        .connect_base_path("con/") // http://[::1]:1025/notifications/con/connect
        .build()?;

pub const fn disconnect_base_path(self, url: &'e str) -> Self

Set cometd server disconnect url path.

Example

    let client = CometdClientBuilder::new(&"http://[::1]:1025/notifications/".parse()?)
        .disconnect_base_path("con/") // http://[::1]:1025/notifications/discon/disconnect
        .build()?;

pub const fn timeout(self, timeout: Duration) -> Self

Set timeout option in handshake request.

pub const fn interval(self, interval: Duration) -> Self

Set interval option in handshake request.

pub fn access_token(self, access_token: impl AccessToken) -> Self

Set access token option in handshake request.

pub fn cookie<N, V>(self, name: N, value: V) -> Selfwhere N: Into<Cow<'static, str>>, V: Into<Cow<'static, str>>,

Set cookie.

pub fn cookies<N, V>(self, cookies: impl IntoIterator<Item = (N, V)>) -> Selfwhere N: Into<Cow<'static, str>>, V: Into<Cow<'static, str>>,

Set cookies.

pub const fn events_channel_capacity( self, events_channel_capacity: usize ) -> Self

Set capacity of Event channel.

pub const fn commands_channel_capacity( self, commands_channel_capacity: usize ) -> Self

Set capacity of internal commands channel.

pub const fn number_of_retries(self, number_of_retries: usize) -> Self

Set number of retries for requests.

pub const fn request_timeout(self, request_timeout: Duration) -> Self

Set requests timeout.

Trait Implementations

impl<'a, 'b, 'c, 'd, 'e> Debug for CometdClientBuilder<'a, 'b, 'c, 'd, 'e>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.