org.stellar.sdk.xdr

Class StateArchivalSettings

java.lang.Object

org.stellar.sdk.xdr.StateArchivalSettings

All Implemented Interfaces:

XdrElement

public class StateArchivalSettings
extends java.lang.Object
implements XdrElement

StateArchivalSettings's original definition in the XDR file is:

 struct StateArchivalSettings {
     uint32 maxEntryTTL;
     uint32 minTemporaryTTL;
     uint32 minPersistentTTL;

     // rent_fee = wfee_rate_average / rent_rate_denominator_for_type
     int64 persistentRentRateDenominator;
     int64 tempRentRateDenominator;

     // max number of entries that emit archival meta in a single ledger
     uint32 maxEntriesToArchive;

     // Number of snapshots to use when calculating average live Soroban State size
     uint32 liveSorobanStateSizeWindowSampleSize;

     // How often to sample the live Soroban State size for the average, in ledgers
     uint32 liveSorobanStateSizeWindowSamplePeriod;

     // Maximum number of bytes that we scan for eviction per ledger
     uint32 evictionScanSize;

     // Lowest BucketList level to be scanned to evict entries
     uint32 startingEvictionScanLevel;
 };
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StateArchivalSettings.StateArchivalSettingsBuilder

Constructor Summary

Constructors

Constructor and Description
StateArchivalSettings()
StateArchivalSettings(Uint32 maxEntryTTL, Uint32 minTemporaryTTL, Uint32 minPersistentTTL, Int64 persistentRentRateDenominator, Int64 tempRentRateDenominator, Uint32 maxEntriesToArchive, Uint32 liveSorobanStateSizeWindowSampleSize, Uint32 liveSorobanStateSizeWindowSamplePeriod, Uint32 evictionScanSize, Uint32 startingEvictionScanLevel)

Method Summary

Modifier and Type	Method and Description
static StateArchivalSettings.StateArchivalSettingsBuilder	builder()
static StateArchivalSettings	decode(XdrDataInputStream stream)
void	encode(XdrDataOutputStream stream)
boolean	equals(java.lang.Object o)
static StateArchivalSettings	fromXdrBase64(java.lang.String xdr)
static StateArchivalSettings	fromXdrByteArray(byte[] xdr)
Uint32	getEvictionScanSize()
Uint32	getLiveSorobanStateSizeWindowSamplePeriod()
Uint32	getLiveSorobanStateSizeWindowSampleSize()
Uint32	getMaxEntriesToArchive()
Uint32	getMaxEntryTTL()
Uint32	getMinPersistentTTL()
Uint32	getMinTemporaryTTL()
Int64	getPersistentRentRateDenominator()
Uint32	getStartingEvictionScanLevel()
Int64	getTempRentRateDenominator()
int	hashCode()
void	setEvictionScanSize(Uint32 evictionScanSize)
void	setLiveSorobanStateSizeWindowSamplePeriod(Uint32 liveSorobanStateSizeWindowSamplePeriod)
void	setLiveSorobanStateSizeWindowSampleSize(Uint32 liveSorobanStateSizeWindowSampleSize)
void	setMaxEntriesToArchive(Uint32 maxEntriesToArchive)
void	setMaxEntryTTL(Uint32 maxEntryTTL)
void	setMinPersistentTTL(Uint32 minPersistentTTL)
void	setMinTemporaryTTL(Uint32 minTemporaryTTL)
void	setPersistentRentRateDenominator(Int64 persistentRentRateDenominator)
void	setStartingEvictionScanLevel(Uint32 startingEvictionScanLevel)
void	setTempRentRateDenominator(Int64 tempRentRateDenominator)
StateArchivalSettings.StateArchivalSettingsBuilder	toBuilder()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.stellar.sdk.xdr.XdrElement

toXdrBase64, toXdrByteArray

Constructor Detail

StateArchivalSettings

public StateArchivalSettings()

StateArchivalSettings

public StateArchivalSettings(Uint32 maxEntryTTL,
                             Uint32 minTemporaryTTL,
                             Uint32 minPersistentTTL,
                             Int64 persistentRentRateDenominator,
                             Int64 tempRentRateDenominator,
                             Uint32 maxEntriesToArchive,
                             Uint32 liveSorobanStateSizeWindowSampleSize,
                             Uint32 liveSorobanStateSizeWindowSamplePeriod,
                             Uint32 evictionScanSize,
                             Uint32 startingEvictionScanLevel)

Method Detail

encode

public void encode(XdrDataOutputStream stream)
            throws java.io.IOException

Specified by:

encode in interface XdrElement

Throws:

java.io.IOException

decode

public static StateArchivalSettings decode(XdrDataInputStream stream)
                                    throws java.io.IOException

Throws:

java.io.IOException

fromXdrBase64

public static StateArchivalSettings fromXdrBase64(java.lang.String xdr)
                                           throws java.io.IOException

Throws:

java.io.IOException

fromXdrByteArray

public static StateArchivalSettings fromXdrByteArray(byte[] xdr)
                                              throws java.io.IOException

Throws:

java.io.IOException

builder

public static StateArchivalSettings.StateArchivalSettingsBuilder builder()

toBuilder

public StateArchivalSettings.StateArchivalSettingsBuilder toBuilder()

getMaxEntryTTL

public Uint32 getMaxEntryTTL()

getMinTemporaryTTL

public Uint32 getMinTemporaryTTL()

getMinPersistentTTL

public Uint32 getMinPersistentTTL()

getPersistentRentRateDenominator

public Int64 getPersistentRentRateDenominator()

getTempRentRateDenominator

public Int64 getTempRentRateDenominator()

getMaxEntriesToArchive

public Uint32 getMaxEntriesToArchive()

getLiveSorobanStateSizeWindowSampleSize

public Uint32 getLiveSorobanStateSizeWindowSampleSize()

getLiveSorobanStateSizeWindowSamplePeriod

public Uint32 getLiveSorobanStateSizeWindowSamplePeriod()

getEvictionScanSize

public Uint32 getEvictionScanSize()

getStartingEvictionScanLevel

public Uint32 getStartingEvictionScanLevel()

setMaxEntryTTL

public void setMaxEntryTTL(Uint32 maxEntryTTL)

setMinTemporaryTTL

public void setMinTemporaryTTL(Uint32 minTemporaryTTL)

setMinPersistentTTL

public void setMinPersistentTTL(Uint32 minPersistentTTL)

setPersistentRentRateDenominator

public void setPersistentRentRateDenominator(Int64 persistentRentRateDenominator)

setTempRentRateDenominator

public void setTempRentRateDenominator(Int64 tempRentRateDenominator)

setMaxEntriesToArchive

public void setMaxEntriesToArchive(Uint32 maxEntriesToArchive)

setLiveSorobanStateSizeWindowSampleSize

public void setLiveSorobanStateSizeWindowSampleSize(Uint32 liveSorobanStateSizeWindowSampleSize)

setLiveSorobanStateSizeWindowSamplePeriod

public void setLiveSorobanStateSizeWindowSamplePeriod(Uint32 liveSorobanStateSizeWindowSamplePeriod)

setEvictionScanSize

public void setEvictionScanSize(Uint32 evictionScanSize)

setStartingEvictionScanLevel

public void setStartingEvictionScanLevel(Uint32 startingEvictionScanLevel)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object