org.jmythapi.protocol.response
Interface ILoad

All Superinterfaces:

Cloneable, IPropertyAware<ILoad.Props>, IVersionable

All Known Implementing Classes:

Load

public interface ILoad
extends IVersionable, IPropertyAware<ILoad.Props>

An interface to get the load of a MythTV backend.

This interface represents the response to a IBackend.queryLoad() request.
This interface is property-aware. See the properties-list for all properties of this interface.

Response example:

<0>LOAD_AVERAGE_NOW: 0.04 | <1>LOAD_AVERAGE_LAST_5MINS: 0.06 | <2>LOAD_AVERAGE_LAST_15MINS: 0.06

Since:

15

See Also:

IBackend.queryLoad()

Nested Class Summary

static class

ILoad.Props The properties of an ILoad response.

Method Summary

double	getCurrentLoad() Gets the current backend load.
double	getLast15MinsLoad() Gets the backend load average of the last 15 minutes.
double	getLast5MinsLoad() Get the backend load average of the last 5 minutes.

Methods inherited from interface org.jmythapi.IVersionable

getVersionNr

Methods inherited from interface org.jmythapi.IPropertyAware

getProperties, getProperty, getPropertyClass, getPropertyCount, getPropertyIndex, getPropertyMap, getPropertyValue, getPropertyValue, getPropertyValueObject, getPropertyValues, setPropertyValue, setPropertyValue, setPropertyValueObject

Method Detail

getCurrentLoad

double getCurrentLoad()

Gets the current backend load.

Returns:

the current backend load

getLast5MinsLoad

double getLast5MinsLoad()

Get the backend load average of the last 5 minutes.

Returns:

the load average of the last 5 minutes

getLast15MinsLoad

double getLast15MinsLoad()

Gets the backend load average of the last 15 minutes.

Returns:

the load average of the last 15 minutes