Struct Connector

pub struct Connector<S: ToSocketAddrs + Clone, V: Into<String> + Clone> { /* private fields */ }

A builder for creating and establishing STOMP connections to a server

This struct provides a builder pattern for configuring the connection parameters and then connecting to a STOMP server.

Examples

use async_stomp::client::Connector;

#[tokio::main]
async fn main() {
  let connection = Connector::builder()
    .server("stomp.example.com")
    .virtualhost("stomp.example.com")
    .login("guest".to_string())
    .passcode("guest".to_string())
    .connect()
    .await;
}

Implementations

impl<S: ToSocketAddrs + Clone, V: Into<String> + Clone> Connector<S, V>

pub fn builder() -> ConnectorBuilder<S, V, ((), (), (), (), (), (), ())>

Create a builder for building Connector. On the builder, call .server(...), .virtualhost(...), .login(...)(optional), .passcode(...)(optional), .headers(...)(optional), .use_tls(...)(optional), .tls_server_name(...)(optional) to set the values of the fields. Finally, call .__build() to create the instance of Connector.

impl<S: ToSocketAddrs + Clone, V: Into<String> + Clone> Connector<S, V>

pub async fn connect(self) -> Result<ClientTransport, Error>

Connect to the STOMP server using the configured parameters

This method establishes a connection to the STOMP server and performs the STOMP protocol handshake. If successful, it returns a ClientTransport that can be used to send and receive STOMP messages.

pub fn msg(self) -> Message<ToServer>

Create a CONNECT message without actually connecting

This method creates a STOMP CONNECT message using the configured parameters which can be used to establish a connection manually.