Struct seedlink::SeedLinkClient

pub struct SeedLinkClient { /* fields omitted */ }

SeedLink Client

Methods

impl SeedLinkClient

fn new(host: &str, port: i64) -> SeedLinkClient

Create a Client that connects to host:port. Connection will attempt to be established.

fn timeout(&mut self, millis: u64) -> Result<usize, SLError>

Set timeout in milliseconds during data reads from the server

fn read(&mut self, buf: &mut [u8]) -> Result<usize, SLError>

Read data from the server.

fn write<S: Into<String>>(&mut self, buf: S) -> Result<usize, SLError>

Write data to the server. This is typically not used directly

fn cmd(&mut self, cmd: &str) -> Result<usize, SLError>

Send raw command to the server

fn bye(&mut self) -> Result<usize, SLError>

Close the connection, say "BYE"

fn cat(&mut self) -> Result<usize, SLError>

Ask for list of stations, say "CAT"

fn hello(&mut self) -> Result<usize, SLError>

Initiate handshaking, say "HELLO"

fn end(&mut self) -> Result<usize, SLError>

Start data transfer (or end multi-station mode handshaking), say "END"

fn start(&mut self) -> Result<usize, SLError>

Start data transfer, see end(), say "END"

fn data_please(&mut self) -> Result<usize, SLError>

Start data transfer, see end(), say "END"

fn backfill(&mut self, when: DateTime<Utc>) -> Result<usize, SLError>

Request data from a timestamp until now, say "TIME when"

fn stream(&mut self, id: &StreamID) -> Result<usize, SLError>

Select station to retrieve, calls station() and select()

fn station(&mut self, sid: &StreamID) -> Result<usize, SLError>

Select station to retrieve, say "STATION station network"

fn select(&mut self, sid: &StreamID) -> Result<usize, SLError>

Select Location and Channel, say "SELECT {location}{channel}"

fn expect_ok(&mut self) -> Result<usize, SLError>

Read and expect an "OK" response from the server

fn time_range(
    &mut self,
    t0: DateTime<Utc>,
    t1: DateTime<Utc>
) -> Result<usize, SLError>

Request data within a time range from server, say "TIME time1 time2"

fn connect(&mut self, verbose: bool) -> Result<usize, SLError>

Handshaking, say "HELLO", read response, return number of bytes read

fn available_streams(&mut self) -> Result<Seedlink, SLError>

Determine available streams. Be carefule, for public servers this can take a bit of time to transfer the underlying data. Say "INFO STREAMS"

Trait Implementations

impl Debug for SeedLinkClient

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.