Struct cometd_client::CometdClientBuilder

pub struct CometdClientBuilder { /* private fields */ }

A builder to construct CometdClient.

Implementations

impl CometdClientBuilder

pub fn new() -> Self

Construct a new ClientBuilder.

pub fn build(self) -> CometdResult<CometdClient>

Return a CometdClient.

Example

use cometd_client::CometdClientBuilder;

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

pub fn endpoint(self, url: &'static str) -> Self

Set cometd server endpoint.

Example

use cometd_client::CometdClientBuilder;

let app = CometdClientBuilder::new()
    .endpoint("http://[::1]:1025/notifications/")
    .build()?;

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

Set cometd server handshake url path.

Example

use cometd_client::CometdClientBuilder;

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

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

Set cometd server subscribe url path.

Example

use cometd_client::CometdClientBuilder;

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

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

Set cometd server connect url path.

Example

use cometd_client::CometdClientBuilder;

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

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

Set cometd server disconnect url path.

Example

use cometd_client::CometdClientBuilder;

let app = CometdClientBuilder::new()
    .connect_base_path("discon/") // http://[::1]:1025/notifications/discon/disconnect
    .endpoint("http://[::1]:1025/notifications/")
    .build()?;

pub fn timeout_ms(self, timeout_ms: u64) -> Self

Set timeout option in handshake request.

pub fn interval_ms(self, interval_ms: u64) -> Self

Set interval option in handshake request.

Trait Implementations

impl Debug for CometdClientBuilder

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

Formats the value using the given formatter.

impl Default for CometdClientBuilder

fn default() -> CometdClientBuilder

Returns the “default value” for a type.