LIBMEMCACHED_CONFIGURATION(3)

📦
version 1.1.4 · 13 versions
, in fedora 43

💖 LIBMEMCACHED_CONFIGURATION(3) 💖

okay so bestie, welcome to the libmemcached-awesome page about libmemcached_configuration — aka the libmemcached Documentation. it's the whole vibe of how you talk to libmemcached in its own lil language. let's get into it 🫶

✨ SYNOPSIS ✨

#include <libmemcached-1.0/memcached.h>
       Compile and link with -lmemcached

memcached_st *memcached(const char *string, size_t string_length)

Parameters

  • string — the configuration string
  • string_length — how long that configuration string is, without any terminating zero

Returns

an allocated and initialized memcached_st struct 💅

memcached_return_t libmemcached_check_configuration(const char
*option_string, size_t length, char *error_buffer, size_t
error_buffer_size)

Parameters

  • option_string — the configuration string
  • length — how long the configuration string is, again without any terminating zero
  • error_buffer — the buffer where any error message gets stored
  • error_buffer_size — how much space the error_buffer actually has available

Returns

a memcached_return_t that indicates success ✨

🌸 DESCRIPTION 🌸

so here's the tea: libmemcached ships its own custom language for configuring and modifying servers. you hand it an option string, and boom — you get a memcached_st object you can use directly in your application. no cap. 👑

🎀 General Options: 🎀

  • --SERVER=<servername>:<optional_port>/?<optional_weight> — gives a servername for the client to use. if you also pass a weight, weighting happens across all hosts, and each server gets a default weight of 1.
  • --SOCKET=\"<filepath>/?<optional_weight>\" — gives a filepath to a UNIX socket file. same deal: passing a weight causes weighting to occur with all hosts, with each server getting a default weight of 1.
  • --VERIFY-KEY — verifies that the keys you're using actually fit within the design of the protocol you're using. vibe check on your keys, basically.
  • --REMOVE_FAILED_SERVERS — enables the behavior MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS.
  • --BINARY-PROTOCOL — forces every connection to use the binary protocol.
  • --BUFFER-REQUESTS — please see MEMCACHED_BEHAVIOR_BUFFER_REQUESTS.
  • --CONFIGURE-FILE= — gives a configuration file to load requests from. ⚠️ beware: if you use a configuration file, libmemcached will reset memcached_st based on information contained only in that file. it's giving full reset, bestie.
  • --CONNECT-TIMEOUT= — see memcached_behavior_set() for MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT.
  • --DISTRIBUTION= — sets the distribution model the client uses. see memcached_behavior_set() for more details.
  • --HASH= — sets the hashing algorithm used for placing keys on servers.
  • --HASH-WITH-NAMESPACE — when enabled, the prefix key gets added to the key when figuring out which server the data goes on. iykyk.
  • --NOREPLY — enables "no reply" for all calls that support it. it is highly recommended that you use this option with the binary protocol only. fr fr, listen to that one.
  • --NUMBER-OF-REPLICAS= — sets how many servers keys get replicated to.
  • --RANDOMIZE-REPLICA-READ — randomly picks the server within the replication pool to read from. main character selection energy 🎲
  • --SORT-HOSTS — when adding new servers, always calculates their distribution based on sorted naming order.
  • --SUPPORT-CAS — see memcached_behavior_set() for MEMCACHED_BEHAVIOR_SUPPORT_CAS.
  • --USE-UDP — see memcached_behavior_set() for MEMCACHED_BEHAVIOR_USE_UDP.
  • --NAMESPACE= — a namespace is a container that provides context for keys; only other requests that know the namespace can access these values. how? by prepending the namespace value to all keys. iconic little secret club 💜

🦋 Memcached Pool Options: 🦋

  • --POOL-MIN — initial size of pool.
  • --POOL-MAX — maximize size of the pool.

🌈 I/O Options: 🌈

  • --TCP-NODELAY — see memcached_behavior_set() for MEMCACHED_BEHAVIOR_TCP_NODELAY.
  • --TCP-KEEPALIVE — see memcached_behavior_set() for MEMCACHED_BEHAVIOR_TCP_KEEPALIVE.
  • --RETRY-TIMEOUT= — see memcached_behavior_set() for MEMCACHED_BEHAVIOR_RETRY_TIMEOUT.
  • --SERVER-FAILURE-LIMIT= — see memcached_behavior_set() for MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT.
  • --SND-TIMEOUT= — see memcached_behavior_set() for MEMCACHED_BEHAVIOR_SND_TIMEOUT.
  • --SOCKET-RECV-SIZE= — see memcached_behavior_set() for MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE.
  • --SOCKET-SEND-SIZE= — see memcached_behavior_set() for MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE.
  • --POLL-TIMEOUT= — sets the timeout used by poll(3).
  • --IO-BYTES-WATERMARK= — (yes bestie, that's all she wrote on this one 🙈)
  • --IO-KEY-PREFETCH= — (no description given, just the option itself)
  • --IO-MSG-WATERMARK= — (no description given, just the option itself)
  • --TCP-KEEPIDLE — (no description given, just the option itself)
  • --RCV-TIMEOUT= — (no description given, just the option itself)

💫 Other Options: 💫

  • INCLUDE — include a file in configuration. unlike --CONFIGURE-FILE=, this will not reset memcached_st.
  • RESET — reset memcached_st and keep processing.
  • END — end configuration processing.
  • ERROR — end configuration processing and throw an error. dramatic exit, honestly 💀

🌟 ENVIRONMENT 🌟

LIBMEMCACHED

💜 RETURN VALUE 💜

memcached() returns a pointer to the memcached_st that was created (or initialized). but if allocation fails, it returns NULL. 😭 so always check, bestie.

⭐ EXAMPLE ⭐

   const char *config_string=
     "--SERVER=host10.example.com "
     "--SERVER=host11.example.com "
     "--SERVER=host10.example.com";
   memcached_st *memc= memcached(config_string, strlen(config_string));
   {
     // ...
   }
   memcached_free(memc);

👑 SEE ALSO 👑

memcached(1) libmemcached(3) memcached_strerror(3)

okay that's the whole page, you ate it up 🍓 this was libmemcached_configuration(3) from libmemcached-awesome, version 1.1, dated Jul 24, 2025. now go forth and configure, periodt 💅✨🦋

📦 where this page comes from