mirror of
https://github.com/valkey-io/valkey.git
synced 2026-05-09 06:49:36 -04:00
curious-george-rk
3d8a1b55ed
Addresses issue #2350 As noted in the issue, much of the expire code uses raw long long for timestamps, which provides no semantic meaning about the unit or purpose of the value. Valkey already defines mstime_t (milliseconds) and ustime_t (microseconds) typedefs — this PR replaces bare long long declarations with the appropriate typedef wherever the value represents an expiration timestamp or time duration. This PR only fixes a small subset in the codebase, but it is an incremental step toward fully replacing the bare long long references. --------- Signed-off-by: curious-george-rk <r.ebu@gmail.com> Co-authored-by: curious-george-rk <r.ebu@gmail.com>
76 lines
2.7 KiB
C
76 lines
2.7 KiB
C
#ifndef _ENTRY_H_
|
|
#define _ENTRY_H_
|
|
|
|
/* Ensure feature macros from fmacros.h are active even if entry.h is
|
|
* included before server.h */
|
|
#include "fmacros.h"
|
|
|
|
#include "sds.h"
|
|
#include "util.h"
|
|
#include <stdbool.h>
|
|
|
|
/*-----------------------------------------------------------------------------
|
|
* Entry
|
|
*----------------------------------------------------------------------------*/
|
|
|
|
/*
|
|
* An "entry" is a field/value sds pair, with an optional expiration time. The
|
|
* entry is used as part of the HASH datatype, and supports hash field expiration.
|
|
*/
|
|
|
|
typedef struct _entry entry;
|
|
|
|
/* The maximum allocation size we want to use for entries with embedded
|
|
* values. */
|
|
#define EMBED_VALUE_MAX_ALLOC_SIZE 128
|
|
|
|
/* Returns the field string (sds) from the entry. */
|
|
sds entryGetField(const entry *entry);
|
|
|
|
/* Returns the value string (sds) from the entry. */
|
|
char *entryGetValue(const entry *entry, size_t *len);
|
|
|
|
/* Gets the expiration timestamp (UNIX time in milliseconds). */
|
|
mstime_t entryGetExpiry(const entry *entry);
|
|
|
|
/* Returns true if the entry has an expiration timestamp set. */
|
|
bool entryHasExpiry(const entry *entry);
|
|
|
|
/* Returns true if the entry value is externalized. */
|
|
bool entryHasStringRef(const entry *entry);
|
|
|
|
/* Sets the expiration timestamp. */
|
|
entry *entrySetExpiry(entry *entry, mstime_t expiry);
|
|
|
|
/* Returns true if the entry is expired compared to current system time (commandTimeSnapshot). */
|
|
bool entryIsExpired(entry *entry);
|
|
|
|
/* Frees the memory used by the entry (including field/value). */
|
|
void entryFree(entry *entry);
|
|
|
|
/* Creates a new entry with the given field, value, and optional expiry. */
|
|
entry *entryCreate(const_sds field, sds value, mstime_t expiry);
|
|
/* Sets the entry's value to a string reference object.
|
|
* The reference points to the provided `buf` but does not assume ownership.
|
|
* An external mechanism must handle the eventual memory deallocation of `buf`. */
|
|
entry *entryUpdateAsStringRef(entry *entry, const char *buf, size_t len, mstime_t expiry);
|
|
|
|
/* Updates the value and/or expiry of an existing entry.
|
|
* In case value is NULL, will use the existing entry value.
|
|
* In case expiry is EXPIRE_NONE, will use the existing entry expiration time. */
|
|
entry *entryUpdate(entry *entry, sds value, mstime_t expiry);
|
|
|
|
/* Returns the total memory used by the entry (in bytes). */
|
|
size_t entryMemUsage(entry *entry);
|
|
|
|
/* Defragments the entry and returns the new pointer (if moved). */
|
|
entry *entryDefrag(entry *entry, void *(*defragfn)(void *), sds (*sdsdefragfn)(sds));
|
|
|
|
/* Advises allocator to dismiss memory used by entry. */
|
|
void entryDismissMemory(entry *entry);
|
|
|
|
/* Internal used for debug. No need to use this function except in tests */
|
|
bool entryHasEmbeddedValue(const entry *entry);
|
|
|
|
#endif
|