Struct KrakenWSSClient

pub struct KrakenWSSClient<'a> { /* private fields */ }

👎Deprecated since 0.1.0: v1 websockets will be removed in the following version - please switch to the supported v2 websockets api

A client for connecting to Kraken websockets.

Connecting to the public (connect) or private (connect_auth) uris returns a KrakenMessageStream that can be awaited for values after sending subscriptions or other messages.

Example: Listening to OHLC/Candles

Creating a client for public messages requires no token or authentication. All that’s needed is to send a valid subscription message for some number of pairs to subscribe to, then listen indefinitely.

use kraken_async_rs::wss::v2::base_messages::{Message, WssMessage};
use kraken_async_rs::wss::v2::kraken_wss_client::KrakenWSSClient;
use kraken_async_rs::wss::v2::market_data_messages::OhlcSubscription;
use std::time::Duration;
use tokio::time::timeout;
use tokio_stream::StreamExt;

#[tokio::main]
async fn main() {
    let mut client = KrakenWSSClient::new();
    let mut kraken_stream = client.connect::<WssMessage>().await.unwrap();

    let ohlc_params = OhlcSubscription::new(vec!["ETH/USD".into()], 60);
    let subscription = Message::new_subscription(ohlc_params, 0);

    let result = kraken_stream.send(&subscription).await;
    assert!(result.is_ok());

    while let Ok(Some(message)) = timeout(Duration::from_secs(10), kraken_stream.next()).await {
        if let Ok(response) = message {
            println!("{:?}", response);
        } else {
            println!("Message failed: {:?}", message);
        }
    }
}

Implementations

impl<'a> KrakenWSSClient<'a>

pub fn new() -> KrakenWSSClient<'a>

Create a client using the default Kraken URLs.

pub fn new_with_urls( base_url: &'a str, auth_url: &'a str, ) -> KrakenWSSClient<'a>

Create a client with custom URLs.

This is most useful for use with a proxy, or for testing.

pub async fn connect( &mut self, ) -> Result<KrakenMessageStream<PublicMessage>, WSSError>

Connect to the Kraken public websocket channel, returning a Result containing a KrakenMessageStream of PublicMessages.

pub async fn connect_auth( &mut self, ) -> Result<KrakenMessageStream<PrivateMessage>, WSSError>

Connect to the Kraken private websocket channel, returning a Result containing a KrakenMessageStream of PrivateMessages.

Trait Implementations

impl<'a> Clone for KrakenWSSClient<'a>

fn clone(&self) -> KrakenWSSClient<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for KrakenWSSClient<'a>

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

Formats the value using the given formatter.

impl<'a> Default for KrakenWSSClient<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Copy for KrakenWSSClient<'a>