public class Archive extends Object implements RrdUpdater, ConsolFuns
Each archive object consists of three parts: archive definition, archive state objects (one state object for each datasource) and round robin archives (one round robin for each datasource). API (read-only) is provided to access each of theese parts.
CF_AVERAGE, CF_FIRST, CF_LAST, CF_MAX, CF_MIN, CF_TOTAL
Constructor and Description |
---|
Archive(RrdDb parentDb,
ArcDef arcDef) |
Archive(RrdDb parentDb,
DataImporter reader,
int arcIndex) |
Modifier and Type | Method and Description |
---|---|
(package private) void |
appendXml(XmlWriter writer) |
void |
archive(int dsIndex,
double value,
long numStepUpdates) |
void |
copyStateTo(RrdUpdater other)
Copies object's internal state to another Archive object.
|
(package private) String |
dump() |
(package private) FetchData |
fetchData(FetchRequest request) |
ArcState |
getArcState(int dsIndex)
Returns the underlying archive state object.
|
long |
getArcStep()
Returns archive time step in seconds.
|
String |
getConsolFun()
Returns archive consolidation function ("AVERAGE", "MIN", "MAX" or "LAST").
|
long |
getEndTime()
Returns current ending timestamp.
|
(package private) RrdDb |
getParentDb() |
Robin |
getRobin(int dsIndex)
Returns the underlying round robin archive.
|
int |
getRows()
Returns the number of archive rows.
|
RrdAllocator |
getRrdAllocator()
Required to implement RrdUpdater interface.
|
RrdBackend |
getRrdBackend()
Returns the underlying storage (backend) object which actually performs all
I/O operations.
|
long |
getStartTime()
Returns current starting timestamp.
|
int |
getSteps()
Returns the number of archive steps.
|
double |
getXff()
Returns archive X-files factor.
|
void |
setXff(double xff)
Sets X-files factor to a new value.
|
String |
toString() |
Archive(RrdDb parentDb, ArcDef arcDef) throws IOException
IOException
Archive(RrdDb parentDb, DataImporter reader, int arcIndex) throws IOException, RrdException, RrdException
IOException
RrdException
public long getArcStep() throws IOException
IOException
- Thrown in case of I/O error.String dump() throws IOException
IOException
RrdDb getParentDb()
public void archive(int dsIndex, double value, long numStepUpdates) throws IOException
IOException
public String getConsolFun() throws IOException
IOException
- Thrown in case of I/O error.public double getXff() throws IOException
IOException
- Thrown in case of I/O error.public int getSteps() throws IOException
IOException
- Thrown in case of I/O error.public int getRows() throws IOException
IOException
- Thrown in case of I/O error.public long getStartTime() throws IOException
IOException
- Thrown in case of I/O error.public long getEndTime() throws IOException
IOException
- Thrown in case of I/O error.public ArcState getArcState(int dsIndex)
dsIndex
- Datasource indexpublic Robin getRobin(int dsIndex)
dsIndex
- Index of the datasource in the RRD.FetchData fetchData(FetchRequest request) throws IOException, RrdException
IOException
RrdException
void appendXml(XmlWriter writer) throws IOException
IOException
public void copyStateTo(RrdUpdater other) throws IOException, RrdException
copyStateTo
in interface RrdUpdater
other
- New Archive object to copy state toIOException
- Thrown in case of I/O errorRrdException
- Thrown if supplied argument is not an Archive objectpublic void setXff(double xff) throws RrdException, IOException
xff
- New X-files factor value. Must be >= 0 and < 1.RrdException
- Thrown if invalid value is suppliedIOException
- Thrown in case of I/O errorpublic RrdBackend getRrdBackend()
getRrdBackend
in interface RrdUpdater
public RrdAllocator getRrdAllocator()
getRrdAllocator
in interface RrdUpdater