Struct icecast_stats::IcecastStats

pub struct IcecastStats {
    pub source: Option<IcecastStatsSourceEnum>,
    // some fields omitted
}

Basic server information

Fields

source: Option<IcecastStatsSourceEnum>

List of active streaming sources

Implementations

impl IcecastStats

pub fn admin(&self) -> &String

As set in the server config, this should contain contact details for getting in touch with the server administrator. Usually this will be an email address, but as this can be an arbitrary string it could also be a phone number.

Example: icemaster@localhost

pub fn client_connections(&self) -> &Option<u32>

Client connections are basically anything that is not a source connection. These include listeners (not concurrent, but cumulative), any admin function accesses, and any static content (file serving) accesses. This is an accumulating counter.

pub fn clients(&self) -> &Option<u32>

Number of currently active client connections.

pub fn connections(&self) -> &Option<u32>

The total of all inbound TCP connections since start-up. This is an accumulating counter.

pub fn file_connections(&self) -> &Option<u32>

This is an accumulating counter.

pub fn host(&self) -> &String

As set in the server config, this should be the full DNS resolveable name or FQDN for the host on which this Icecast instance is running.

Example: localhost

pub fn listener_connections(&self) -> &Option<u32>

Number of listener connections to mount points. This is an accumulating counter.

pub fn listeners(&self) -> &Option<u32>

Number of currently active listener connections.

pub fn location(&self) -> &String

As set in the server config, this is a free form field that should describe e.g. the physical location of this server.

Example: Earth

pub fn server_id(&self) -> &String

Defaults to the version string of the currently running Icecast server. While not recommended it can be overriden in the server config.

Example: Icecast 2.4.4

pub fn source_client_connections(&self) -> &Option<u32>

Source client connections are the number of times (cumulative since start-up, not just currently connected) a source client has connected to Icecast. This is an accumulating counter.

pub fn source_relay_connections(&self) -> &Option<u32>

Number of outbound relay connections to (master) icecast servers. This is an accumulating counter.

pub fn source_total_connections(&self) -> &Option<u32>

Both clients and relays. This is an accumulating counter.

pub fn sources(&self) -> &Option<u32>

The total of currently connected sources.

pub fn stats(&self) -> &Option<u32>

The total of currently connected STATS clients.

pub fn stats_connections(&self) -> &Option<u32>

Number of times a stats client has connected to Icecast. This is an accumulating counter.

pub fn server_start_iso8601(&self) -> &String

Timestamp of server startup in ISO 8601 date format.

Example: 2021-04-09T21:49:50+0200

Trait Implementations

impl Clone for IcecastStats

fn clone(&self) -> IcecastStats

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IcecastStats

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IcecastStats

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for IcecastStats

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.