REDROOM

Navigation

Breadcrumbs

/ / usr / include / proftpd

Create

Create File | Create Folder | Upload Files | Run Command

Edit File Size: 4.94 KB

/usr/include/proftpd/memcache.h

Text Base64

/*
 * ProFTPD - FTP server daemon
 * Copyright (c) 2010-2015 The ProFTPD Project team
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335, USA.
 *
 * As a special exemption, The ProFTPD Project team and other respective
 * copyright holders give permission to link this program with OpenSSL, and
 * distribute the resulting executable, without including the source code for
 * OpenSSL in the source distribution.
 */

/* Memcache support */

#ifndef PR_MEMCACHE_H
#define PR_MEMCACHE_H

#include "conf.h"

typedef struct mcache_rec pr_memcache_t;

/* Core API for use by modules et al */

/* This function returns the pr_memcache_t for the current session; if one
 * does not exist, it will be allocated.
 */
pr_memcache_t *pr_memcache_conn_get(void);
pr_memcache_t *pr_memcache_conn_new(pool *p, module *owner,
  unsigned long flags, uint64_t nreplicas);
int pr_memcache_conn_close(pr_memcache_t *mcache);

/* Given an existing handle, quit that handle, and clone the internal
 * structures.  This is to be used by modules which need to get their own
 * process-specific handle, using a handle inherited from their parent process.
 */
int pr_memcache_conn_clone(pool *p, pr_memcache_t *mcache);

/* Set a namespace key prefix, to be used by this connection for all of the
 * operations involving items.  In practice, the key prefix should always
 * be a string which does contain any space characters.
 *
 * Different modules can use different namespace prefixes for their keys.
 * Setting NULL for the namespace prefix clears it.
 */
int pr_memcache_conn_set_namespace(pr_memcache_t *mcache, module *m,
  const char *prefix);

int pr_memcache_add(pr_memcache_t *mcache, module *m, const char *key,
  void *value, size_t valuesz, time_t expires, uint32_t flags);
int pr_memcache_decr(pr_memcache_t *mcache, module *m, const char *key,
  uint32_t decr, uint64_t *value);
void *pr_memcache_get(pr_memcache_t *mcache, module *m, const char *key,
  size_t *valuesz, uint32_t *flags);
char *pr_memcache_get_str(pr_memcache_t *mcache, module *m, const char *key,
  uint32_t *flags);
int pr_memcache_incr(pr_memcache_t *mcache, module *m, const char *key,
  uint32_t incr, uint64_t *value);
int pr_memcache_remove(pr_memcache_t *mcache, module *m, const char *key,
  time_t expires);
int pr_memcache_set(pr_memcache_t *mcache, module *m, const char *key,
  void *value, size_t valuesz, time_t expires, uint32_t flags);

/* Variants of the above, where the key values are arbitrary bits rather
 * than being assumed to be strings.
 */
int pr_memcache_kadd(pr_memcache_t *mcache, module *m, const char *key,
  size_t keysz, void *value, size_t valuesz, time_t expires, uint32_t flags);
int pr_memcache_kdecr(pr_memcache_t *mcache, module *m, const char *key,
  size_t keysz, uint32_t decr, uint64_t *value);
void *pr_memcache_kget(pr_memcache_t *mcache, module *m, const char *key,
  size_t keysz, size_t *valuesz, uint32_t *flags);
char *pr_memcache_kget_str(pr_memcache_t *mcache, module *m, const char *key,
  size_t keysz, uint32_t *flags);
int pr_memcache_kincr(pr_memcache_t *mcache, module *m, const char *key,
  size_t keysz, uint32_t incr, uint64_t *value);
int pr_memcache_kremove(pr_memcache_t *mcache, module *m, const char *key,
  size_t keysz, time_t expires);
int pr_memcache_kset(pr_memcache_t *mcache, module *m, const char *key,
  size_t keysz, void *value, size_t valuesz, time_t expires, uint32_t flags);

/* For internal use only */

unsigned long memcache_get_sess_flags(void);
#define PR_MEMCACHE_FL_NO_BINARY_PROTOCOL	0x001
#define PR_MEMCACHE_FL_NO_RANDOM_REPLICA_READ	0x002

int memcache_set_sess_connect_failures(uint64_t count);
int memcache_set_sess_flags(unsigned long flags);
int memcache_set_sess_replicas(uint64_t count);
int memcache_set_servers(void *server_list);

/* Configure the timeouts in millisecs.
 *
 * The last timeout argument is timeout in seconds.  When a server is marked
 * as "dead", that server will be automatically ejected from the pool of servers
 * used for storage/retrieval.  This "ejected timeout" argument configures the
 * number of seconds that an ejected server will be out of the pool, before
 * being added back in.
 */
int memcache_set_timeouts(unsigned long conn_millis, unsigned long read_millis,
  unsigned long write_millis, unsigned long ejected_sec);

int memcache_clear(void);
int memcache_init(void);

#endif /* PR_MEMCACHE_H */

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Directory Contents

Dirs: 0 × Files: 76

Sort:

Enable drag-to-move

Name	Size	Perms	Modified	Actions
ascii.h	2.61 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
auth.h	6.23 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
base.h	3.42 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
bindings.h	7.84 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
buildstamp.h	50 B	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
ccan-json.h	3.59 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
child.h	1.48 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
class.h	3.02 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
cmd.h	4.36 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
compat.h	1.29 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
conf.h	3.86 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
config.h	35.77 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
configdb.h	5.73 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
ctrls.h	8.32 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
data.h	2.52 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
default_paths.h	2.97 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
dirtree.h	7.47 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
display.h	2.46 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
encode.h	3.67 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
env.h	1.87 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
error.h	18.45 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
event.h	3.50 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
expr.h	2.16 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
feat.h	1.27 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
filter.h	2.06 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
fsio.h	19.07 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
ftp.h	8.98 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
glibc-glob.h	7.12 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
hanson-tpl.h	4.40 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
help.h	1.24 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
ident.h	1.30 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
inet.h	5.27 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
jot.h	8.53 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
json.h	6.13 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
lastlog.h	1.62 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
log.h	6.66 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
logfmt.h	3.36 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
memcache.h	4.94 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
mkhome.h	1.53 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
modules.h	6.32 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
mod_ctrls.h	3.96 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
mod_sftp.h	10.70 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
mod_tls.h	6.33 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
netacl.h	2.51 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
netaddr.h	15.62 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
netio.h	7.98 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
openbsd-blowfish.h	2.90 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
options.h	8.33 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
os.h	7.22 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
parser.h	6.20 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
pidfile.h	1.30 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
pool.h	4.04 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
pr-syslog.h	3.47 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
privs.h	2.55 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
proctitle.h	1.64 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
proftpd.h	9.50 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
random.h	1.29 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
redis.h	15.58 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
regexp.h	3.63 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
response.h	3.07 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
rlimit.h	1.83 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
scoreboard.h	4.65 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
session.h	4.33 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
sets.h	1.94 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
signals.h	1.83 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
stash.h	2.12 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
str.h	5.59 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
support.h	4.39 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
table.h	11.60 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
throttle.h	1.27 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
timers.h	3.29 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
trace.h	2.36 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
utf8.h	1.37 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
var.h	4.32 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
version.h	1.59 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive
xferlog.h	1.34 KB	lrw-r--r--	2025-06-09 17:22:04	Edit Download recursive recursive