Package org.gnome.soup

Class Cache

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.soup.Cache

All Implemented Interfaces:

Proxy, SessionFeature

@Generated("io.github.jwharm.JavaGI")
public class Cache
extends GObject
implements SessionFeature

File-based cache for HTTP resources.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Cache.Builder<B extends Cache.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	Cache.CacheClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.soup.SessionFeature

SessionFeature.SessionFeatureImpl, SessionFeature.SessionFeatureInterface

Constructor Summary

Constructors

Constructor	Description
Cache(@Nullable String cacheDir, CacheType cacheType)	Creates a new SoupCache.
Cache(MemorySegment address)	Create a Cache proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected Cache	asParent()	Returns this instance as if it were its parent type.
static Cache.Builder<? extends Cache.Builder>	builder()	A Cache.Builder object constructs a Cache with the specified properties.
void	clear()	Will remove all entries in the this Cache plus all the cache files.
void	dump()	Synchronously writes the cache index out to disk.
void	flush()	Forces all pending writes in the this Cache to be committed to disk.
protected Set<Cacheability>	getCacheability(Message msg)
int	getMaxSize()	Gets the maximum size of the cache.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static Type	getType()	Get the GType of the Cache class
void	load()	Loads the contents of this Cache's index into memory.
void	setMaxSize(int maxSize)	Sets the maximum size of the cache.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.github.jwharm.javagi.base.Proxy

handle

Constructor Details

Cache

public Cache(MemorySegment address)

Create a Cache proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Cache

public Cache(@Nullable
 @Nullable String cacheDir,
 CacheType cacheType)
      throws UnsupportedPlatformException

Creates a new SoupCache.

Parameters:

cacheDir - the directory to store the cached data, or null to use the default one. Note that since the cache isn't safe to access for multiple processes at once, and the default directory isn't namespaced by process, clients are strongly discouraged from passing null.

cacheType - the SoupCacheType of the cache

Throws:

UnsupportedPlatformException - when run on a platform other than linux

Method Details

getType

public static Type getType()

Get the GType of the Cache class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected Cache asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

clear

public void clear()

Will remove all entries in the this Cache plus all the cache files.

This is not thread safe and must be called only from the thread that created the SoupCache

dump

public void dump()

Synchronously writes the cache index out to disk.

Contrast with flush(), which writes pending cache entries to disk.

You must call this before exiting if you want your cache data to persist between sessions.

This is not thread safe and must be called only from the thread that created the SoupCache

flush

public void flush()

Forces all pending writes in the this Cache to be committed to disk.

For doing so it will iterate the GLib.MainContext associated with this Cache's session as long as needed.

Contrast with dump(), which writes out the cache index file.

getMaxSize

public int getMaxSize()

Gets the maximum size of the cache.

Returns:

the maximum size of the cache, in bytes.

load

public void load()

Loads the contents of this Cache's index into memory.

This is not thread safe and must be called only from the thread that created the SoupCache

setMaxSize

public void setMaxSize(int maxSize)

Sets the maximum size of the cache.

Parameters:

maxSize - the maximum size of the cache, in bytes

getCacheability

protected Set<Cacheability> getCacheability(Message msg)

builder

public static Cache.Builder<? extends Cache.Builder> builder()

A Cache.Builder object constructs a Cache with the specified properties. Use the various set...() methods to set properties, and finish construction with Cache.Builder.build().