LIBMEMCACHE...NFIGURATION(3)

📦
version 1.1.4 · 13 versions
, in fedora 43

🌸 NAME 🌸

okay so this is the libmemcached-awesome manual page LIBMEMCACHE...NFIGURATION(3), section 3 of the manual, and it's all about this one function:

libmemcached_check_configuration — literally it's the libmemcached Documentation, that's the whole name, bestie 💖

✨ 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, queen
  • string_length — how long that configuration string is, without any terminating zero (no sneaky \0 counted, okay?)

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 — length of the configuration string, again without any terminating zero
  • error_buffer — the buffer where any error message gets stored
  • error_buffer_size — how much room the error_buffer actually has

Returns — a memcached_return_t indicating success ✨

💅 DESCRIPTION 💅

okay so libmemcached straight up invented its own little custom language for configuring and modifying servers. You pass in an option string, and boom — you get a memcached_st object you can use in your application directly. it's giving build-your-own-memcached-client, and honestly? iconic 👑

🌈 General Options:

  • --SERVER=<servername>:<optional_port>/?<optional_weight> — hand over a servername for the client to use. And if you also give a weight, weighting kicks in across all hosts, with every server starting out at a default weight of 1 💖
  • --SOCKET=\"<filepath>/?<optional_weight>\" — hand over a filepath to a UNIX socket file. Give a weight too and weighting happens across all hosts, each server getting a default weight of 1.
  • --VERIFY-KEY — double-check that the keys you're using actually fit inside the design of the protocol you're using. vibe check for keys, fr fr 🔍
  • --REMOVE_FAILED_SERVERS — turns on the behavior MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS. bye bye failed servers 👋
  • --BINARY-PROTOCOL — forces all connections to use the binary protocol. no exceptions.
  • --BUFFER-REQUESTS — please go look at MEMCACHED_BEHAVIOR_BUFFER_REQUESTS, that's your girl.
  • --CONFIGURE-FILE= — give it a configuration file to load requests from. > ⚠️ but beware bestie: using a configuration file means libmemcached will reset memcached_st based on information that's only contained in that file. your old settings? gone. 😭
  • --CONNECT-TIMEOUT= — see memcached_behavior_set() for MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT.
  • --DISTRIBUTION= — sets the distribution model the client uses. see memcached_behavior_set() for the deets.
  • --HASH= — sets the hashing algorithm used for placing keys on servers.
  • --HASH-WITH-NAMESPACE — when this is enabled, the prefix key gets added to the key when figuring out which server the data lives on.
  • --NOREPLY — enables "no reply" for all the calls that support it. and it is highly recommended that you only use this with the binary protocol, okay? don't be messy.
  • --NUMBER-OF-REPLICAS= — sets how many servers your keys get replicated to.
  • --RANDOMIZE-REPLICA-READ — picks the server to read from randomly out of the replication pool. main character selection energy 🎲
  • --SORT-HOSTS — when new servers get added, always calculate 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 gives context to keys, and only other requests that know the namespace can get to those values. how does it do it? by prepending the namespace value to all your keys. cute, simple, effective 🎀

🧚 Memcached Pool Options:

  • --POOL-MIN — initial size of the 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= — that's it, that's the whole entry, the page doesn't tell us more 🙈
  • --IO-KEY-PREFETCH= — same situation, name only, no description on the page 😭
  • --IO-MSG-WATERMARK= — again, just the name, that's all we got 💀
  • --TCP-KEEPIDLE — name only, bestie, no extra details here.
  • --RCV-TIMEOUT= — name only too, we keep it real.

👑 Other Options:

  • INCLUDE — includes a file in the configuration. and unlike --CONFIGURE-FILE=, this one will not reset memcached_st. huge difference, don't mix them up 🫶
  • RESET — resets memcached_st and keeps on processing. clean slate, keep going 💅
  • END — ends configuration processing. that's a wrap.
  • ERROR — ends configuration processing and throws an error. dramatic exit, love that for us.

🌱 ENVIRONMENT 🌱

LIBMEMCACHED

⭐ RETURN VALUE ⭐

memcached() returns a pointer to the memcached_st that got created (or initialized). and if an allocation fails? it returns NULL. so always check your pointers, bestie, no cap 🫶

🎀 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)

and that's the whole page, periodt 💖 this was libmemcached-awesome manual page LIBMEMCACHE...NFIGURATION(3), version 1.1, dated Jul 24, 2025 — go forth and configure your servers, you absolute icon ✨👑🦋

📦 where this page comes from