Package io.sentry.cache

Class EnvelopeCache

java.lang.Object

io.sentry.cache.EnvelopeCache

All Implemented Interfaces:

IEnvelopeCache, Iterable<SentryEnvelope>

@Internal
public class EnvelopeCache
extends Object
implements IEnvelopeCache

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CRASH_MARKER_FILE
protected final @NotNull File	directory
static final String	NATIVE_CRASH_MARKER_FILE
protected final @NotNull SentryOptions	options
static final String	PREFIX_CURRENT_SESSION_FILE
static final String	PREFIX_PREVIOUS_SESSION_FILE
protected final @NotNull ISerializer	serializer
static final String	STARTUP_CRASH_MARKER_FILE
static final String	SUFFIX_ENVELOPE_FILE	File suffix added to all serialized envelopes files.
protected static final Charset	UTF_8

Constructor Summary

Constructors

Constructor	Description
EnvelopeCache(@NotNull SentryOptions options, @NotNull String cacheDirPath, int maxCacheItems)

Method Summary

Modifier and Type	Method	Description
static @NotNull IEnvelopeCache	create(@NotNull SentryOptions options)
void	discard(@NotNull SentryEnvelope envelope)
void	flushPreviousSession()
static @NotNull File	getCurrentSessionFile(@NotNull String cacheDirPath)
static @NotNull File	getPreviousSessionFile(@NotNull String cacheDirPath)
protected boolean	isDirectoryValid()	Check if a dir.
@NotNull Iterator<SentryEnvelope>	iterator()
protected void	rotateCacheIfNeeded(@NotNull File[] files)	Rotates the caching folder if full, deleting the oldest files first
void	store(@NotNull SentryEnvelope envelope, @NotNull Hint hint)
boolean	waitPreviousSessionFlush()	Awaits until the previous session (if any) is flushed to its own file.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.sentry.cache.IEnvelopeCache

store

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

SUFFIX_ENVELOPE_FILE

public static final String SUFFIX_ENVELOPE_FILE

File suffix added to all serialized envelopes files.

See Also:

• Constant Field Values

PREFIX_CURRENT_SESSION_FILE

public static final String PREFIX_CURRENT_SESSION_FILE

See Also:

• Constant Field Values

PREFIX_PREVIOUS_SESSION_FILE

public static final String PREFIX_PREVIOUS_SESSION_FILE

See Also:

• Constant Field Values

CRASH_MARKER_FILE

public static final String CRASH_MARKER_FILE

See Also:

• Constant Field Values

NATIVE_CRASH_MARKER_FILE

public static final String NATIVE_CRASH_MARKER_FILE

See Also:

• Constant Field Values

STARTUP_CRASH_MARKER_FILE

public static final String STARTUP_CRASH_MARKER_FILE

See Also:

• Constant Field Values

UTF_8

protected static final Charset UTF_8

options

@NotNull
protected final @NotNull SentryOptions options

serializer

@NotNull
protected final @NotNull ISerializer serializer

directory

@NotNull
protected final @NotNull File directory

Constructor Details

EnvelopeCache

public EnvelopeCache(@NotNull
 @NotNull SentryOptions options,
 @NotNull
 @NotNull String cacheDirPath,
 int maxCacheItems)

Method Details

create

@NotNull
public static @NotNull IEnvelopeCache create(@NotNull
 @NotNull SentryOptions options)

store

public void store(@NotNull
 @NotNull SentryEnvelope envelope,
 @NotNull
 @NotNull Hint hint)

Specified by:

store in interface IEnvelopeCache

discard

public void discard(@NotNull
 @NotNull SentryEnvelope envelope)

Specified by:

discard in interface IEnvelopeCache

getCurrentSessionFile

@NotNull
public static @NotNull File getCurrentSessionFile(@NotNull
 @NotNull String cacheDirPath)

getPreviousSessionFile

@NotNull
public static @NotNull File getPreviousSessionFile(@NotNull
 @NotNull String cacheDirPath)

iterator

@NotNull
public @NotNull Iterator<SentryEnvelope> iterator()

Specified by:

iterator in interface Iterable<SentryEnvelope>

waitPreviousSessionFlush

public boolean waitPreviousSessionFlush()

Awaits until the previous session (if any) is flushed to its own file.

flushPreviousSession

public void flushPreviousSession()

isDirectoryValid

protected boolean isDirectoryValid()

Check if a dir. is valid and have write and read permission

Returns:

true if valid and has permissions or false otherwise

rotateCacheIfNeeded

protected void rotateCacheIfNeeded(@NotNull
 @NotNull File[] files)

Rotates the caching folder if full, deleting the oldest files first

Parameters:

files - the Files