MEMCACHED_SERVER_PUSH(3)

📦
version 1.1.4 · 13 versions
, in fedora 43

💖 NAME 💖

memcached_server_push — libmemcached Documentation 💅

okay so bestie, quick vibe check: this is page 3 of the libmemcached-awesome manual, and it's literally the group chat where you manage your whole server list. adding servers, counting servers, peeking at servers, sliding callbacks across servers. we do it all here. 🦋

✨ SYNOPSIS ✨

First things first, you gotta pull the header in, no cap:

#include <libmemcached/memcached.h>

and then compile and link with -lmemcached — that's the whole deal, that's the ritual 🫶

👑 uint32_t memcached_server_count(memcached_st *ptr)

Parameters

  • ptr — pointer to initialized memcached_st struct

Returns

number of configured servers 🔥

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

Parameters

  • ptr — pointer to initialized memcached_st struct
  • hostname — hostname or IP address of the TCP server to add
  • port — port of the TCP server

Returns

memcached_return_t indicating success ✨

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

Parameters

  • ptr — pointer to initialized memcached_st struct
  • hostname — hostname or IP address of the UDP server to add
  • port — port of the UDP server

Returns

memcached_return_t indicating success ✨

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

Parameters

  • ptr — pointer to initialized memcached_st struct
  • socket — path to the UNIX socket of the server to add

Returns

memcached_return_t indicating success ✨

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

Parameters

  • ptr — pointer to initialized memcached_st struct
  • list — pre-configured list of servers to push

Returns

memcached_return_t indicating success ✨

💜 const memcached_instance_st *memcached_server_by_key(memcached_st *ptr, const char *key, size_t key_length, memcached_return_t *error)

Parameters

  • ptr — pointer to initialized memcached_st struct
  • key — key to hash and lookup a server
  • key_length — length of key without any terminating zero
  • error — pointer to memcached_return_t indicating success

Returns

the server instance to be used for storing/retrieving key 🌈

💀 const memcached_instance_st *memcached_server_get_last_disconnect(const memcached_st *ptr)

Parameters

  • ptr — pointer to initialized memcached_st struct

Returns

the instance of the last server for which there was a connection problem 😭

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

Parameters

  • ptr — pointer to initialized memcached_st struct
  • callback — list of memcached_server_fn to be called for each server instance
  • context — pointer to user supplied context for the callback
  • number_of_callbacks — number of callbacks supplied

Returns

memcached_return_t indicating success ✨

🦋 typedef memcached_return_t (*memcached_server_fn)(const memcached_st *ptr, const memcached_instance_st *server, void *context)

Param ptr — pointer to the memcached_st struct

Param server — pointer to memcached_instance_st

Param context — pointer to user supplied context

Returns

memcached_return_t indicating success ✨

💅 DESCRIPTION 💅

so here's the tea, bestie: libmemcached is out here performing operations on a whole list of hosts, and the order of those hosts is literally what determines routing to keys. that's the main character mechanic. functions are provided to add keys to memcached_st structures. and if you wanna manipulate lists of servers, you go see memcached_server_st. iykyk 🫶

memcached_server_count() gives you a count of the current number of servers being used by a memcached_st structure. simple. iconic. no notes.

memcached_server_add() pushes a single TCP server into the memcached_st structure. this server will be placed at the end. duplicate servers are allowed, so duplication is not checked — the library is not gonna be your accountability buddy here 🙈. executing this function with the MEMCACHED_BEHAVIOR_USE_UDP behavior set will result in a MEMCACHED_INVALID_HOST_PROTOCOL.

memcached_server_add_udp() pushes a single UDP server into the memcached_st structure. this server will be placed at the end. duplicate servers are allowed, so duplication is not checked. executing this function without setting the MEMCACHED_BEHAVIOR_USE_UDP behavior will result in a MEMCACHED_INVALID_HOST_PROTOCOL. yeah it's the mirror-image of the last one, they're giving opposites-attract energy 💀

memcached_server_add_unix_socket() pushes a single UNIX socket into the memcached_st structure. this UNIX socket will be placed at the end. duplicate servers are allowed, so duplication is not checked. and the length of the filename must be one character less than MEMCACHED_MAX_HOST_LENGTH. that's the rule, periodt.

memcached_server_push() pushes an array of memcached_server_st into the memcached_st structure. these servers will be placed at the end. duplicate servers are allowed, so duplication is not checked. a copy is made of the structure, so the list provided (and any operations on the list) are not saved. your original list is safe, it's not catching strays 💖

memcached_server_by_key() allows you to provide a key and retrieve the server which would be used for assignment. it's giving "who's the chosen one for this key" energy 🔥

memcached_server_get_last_disconnect() returns a pointer to the last server for which there was a connection problem. and lowkey important: it does not mean this particular server is currently dead — but if the library is reporting a server is, the returned server is a very good candidate. prime suspect behavior, not a conviction ⭐

memcached_server_cursor() takes a memcached_st and loops through the list of hosts currently in the cursor, calling the list of callback functions provided. you can optionally pass in a value via context which will be provided to each callback function. an error return from any callback will terminate the loop. and memcached_server_cursor() is passed the original caller memcached_st in its current state. so it's the real thing, not a copy, no substitutes 💅

🌈 RETURN VALUE 🌈

Varies, see particular functions. (yes that's the whole answer, it's giving "read the room" but fr fr, each function's Returns section above has the details 👑

🎀 SEE ALSO 🎀

and that's the whole page, bestie!! you just read version 1.1 of this manual page, dated Jul 24, 2025, from the libmemcached-awesome collection — go forth and push some servers 💖✨🎀🦋🌸💅🫶

📦 where this page comes from