Struct Connector

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

Create a connection to a STOMP server via TCP, including the connection handshake. If successful, returns a tuple of a message stream and a sender, which may be used to receive and send messages respectively.

virtualhost If no specific virtualhost is desired, it is recommended to set this to the same as the host name that the socket was established against (i.e, the same as the server address).

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, V: Into<String>> 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) to set the values of the fields. Finally, call .__build() to create the instance of Connector.

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

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

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