Memcac...ervers(3pm)

📦
version 1.001801 · 7 versions
, in ubuntu stonking

💖 Memcac...ervers(3pm) 💖

okay bestie, so this is a chunk of the User Contributed Perl Documentation for the <rainbow>Memcac...ervers</rainbow> section, and it's literally all about managing your server list. it's giving infrastructure queen energy and i'm obsessed. 👑

✨ NAME ✨

memcached_server_count, memcached_server_list, memcached_server_add, memcached_server_push, memcached_server_get_last_disconnect, memcached_server_cursor — the whole squad that handles Manage server list. 🫶

📚 LIBRARY 📚

C Client Library for memcached (libmemcached, -lmemcached) — that's the C client, not the Perl one, don't get it twisted. 💅

🎀 SYNOPSIS 🎀

here's the whole cast list, verbatim, no cap:

#include <memcached.h>

uint32_t memcached_server_count (memcached_st *ptr);

memcached_return_t
  memcached_server_add (memcached_st *ptr,
                        const char *hostname,
                        in_port_t port);

memcached_return_t
  memcached_server_add_udp (memcached_st *ptr,
                            const char *hostname,
                            in_port_t port);

memcached_return_t
  memcached_server_add_unix_socket (memcached_st *ptr,
                                    const char *socket);

memcached_return_t
  memcached_server_push (memcached_st *ptr,
                         const memcached_server_st *list);

memcached_server_instance_st
  memcached_server_by_key (const memcached_st *ptr,
                           const char *key,
                           size_t key_length,
                           memcached_return_t *error);

memcached_server_instance_st
  memcached_server_get_last_disconnect (const memcached_st *ptr)

memcached_return_t
  memcached_server_cursor(const memcached_st *ptr,
                          const memcached_server_fn *callback,
                          void *context,
                          uint32_t number_of_callbacks);

🌸 DESCRIPTION 🌸

so libmemcached(3) does its whole thing on a list of hosts, and the order of those hosts? that's literally what determines routing to keys. like, the lineup matters, bestie. 📋

there are functions here to add keys to memcached_st structures, and if you wanna manipulate lists of servers themselves, go look at memcached_server_st(3) instead. different vibe, different page. 💫

  • memcached_server_count() — hands you the count of how many servers your memcached_st structure is currently using. a headcount. a lil census. 🔢
  • memcached_server_add() — pushes one single TCP server into the memcached_st structure, and it lands at the end. duplicate servers are allowed, so nothing's getting checked, no dedupe, sorry girl. and heads up: if you run this while the MEMCACHED_BEHAVIOR_USE_UDP behavior is set, you get a MEMCACHED_INVALID_HOST_PROTOCOL. pick a lane. 😭
  • memcached_server_add_udp() — same deal but UDP: pushes a single UDP server into the memcached_st structure, placed at the end, duplicates allowed, no checking. and the reverse gotcha: run this without setting the MEMCACHED_BEHAVIOR_USE_UDP behavior and you get MEMCACHED_INVALID_HOST_PROTOCOL. it's giving "you had one job". 💀
  • memcached_server_add_unix_socket() — pushes a single UNIX socket into the memcached_st structure, at the end, duplicates allowed, not checked. one very specific rule tho: the filename length has to be one character less than MEMCACHED_MAX_HOST_LENGTH. count your characters, babe. 🧚
  • memcached_server_push() — this one yeets an array of memcached_server_st into the memcached_st structure, at the end, duplicates allowed, not checked. and here's the tea: a copy is made of the structure, so the list you handed over (and any operations you do on that list) are not saved. it's a snapshot, not a situationship. 📸
  • memcached_server_by_key() — give it a key and it tells you which server would be used for assignment. the returned structure is cloned from its original, so you must free it. if NULL comes back, go consult *error. and free that returned structure with memcached_server_free(). free it. free it. 🫶
  • memcached_server_get_last_disconnect() — returns a pointer to the last server that had a connection problem. important nuance: this does not mean that particular server is currently dead — but if the library is reporting a server dead, the returned one is a very good candidate. prime suspect, not convicted. 🕵️
  • memcached_server_cursor() — takes a memcached_st and loops through the list of hosts currently in the cursor, calling the list of callback functions you provided. you can optionally pass a value in via context, and that gets handed to each callback function. if any callback returns an error, the loop is terminated, periodt. also: memcached_server_cursor() gets passed the original caller's memcached_st in its current state. 🌀

🔥 RETURN 🔥

Varies — go read the particular function you're nosy about. it's giving "results may vary". 🙈

🏠 HOME 🏠

wanna find out more? go here, bestie: <https://launchpad.net/libmemcached>

👑 AUTHOR 👑

Brian Aker, <brian@tangent.org> — the icon, the legend, the moment. ✨

🌈 SEE ALSO 🌈

and that's a wrap on the Memcac...ervers(3pm) page!! this lil doc came to you via perl v5.42.3 on 2026-08-19 — go forth and manage your servers, you absolute main character. no cap, ily. 💅🦋💖

📦 where this page comes from