Struct mixer_wrappers::constellation::ConstellationClient

pub struct ConstellationClient {
    pub join_handle: JoinHandle<()>,
    // some fields omitted
}

Wrapper for connecting and interacting with Constellation.

Fields

join_handle: JoinHandle<()>

Internal thread join handle

Methods

impl ConstellationClient

pub fn connect(client_id: &str) -> Result<(Self, Receiver<String>), Error>

Connect to Constellation.

Arguments

• client_id - your client ID

Examples

use mixer_wrappers::ConstellationClient;
let (client, receiver) = ConstellationClient::connect("aaa").unwrap();

pub fn call_method(
    &mut self,
    method: &str,
    params: &HashMap<String, Value>
) -> Result<(), Error>

Call a method, sending data to the socket.

Arguments

• method - method name
• params - method parameters

Examples

let mut map = HashMap::new();
map.insert(String::from("abc"), json!(123));
if let Err(e) = client.call_method("some_method", &map) {
    // ...
}

pub fn subscribe(&mut self, events: &[&str]) -> Result<(), Error>

Subscribe to events.

The documentation on this method is found here, as well as a listing of events.

Arguments

• events - slice of event names to subscribe to

Examples

client.subscribe(&["aaa", "bbb"]).unwrap();

pub fn unsubscribe(&mut self, events: &[&str]) -> Result<(), Error>

Unsubscribe from events.

The documentation on this method is found here, as well as a listing of events.

Arguments

• events - slice of event names to subscribe to

Examples

client.unsubscribe(&["aaa", "bbb"]).unwrap();

pub fn parse(message: &str) -> Result<StreamMessage, Error>

Helper method to parse the JSON messages into structs.

Arguments

• message - String message from the receiver

Examples

let message = ConstellationClient::parse("{\"type\":\"event\"...}").unwrap();