X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fsource%2Flibmemcached%2Fmemcached_server_st.rst;h=1ca82c1cea9519bff52d623f3e5d76661841c98f;hb=52027f889cdd7435ae3cba934f190996ad739a3a;hp=faa7c4c9e6c91014ce7011fd7a4ff48ea31b3464;hpb=bd68f254afbf924020f10bd7dcadac8f2aa3affa;p=awesomized%2Flibmemcached diff --git a/docs/source/libmemcached/memcached_server_st.rst b/docs/source/libmemcached/memcached_server_st.rst index faa7c4c9..1ca82c1c 100644 --- a/docs/source/libmemcached/memcached_server_st.rst +++ b/docs/source/libmemcached/memcached_server_st.rst @@ -9,14 +9,19 @@ SYNOPSIS .. c:type:: struct memcached_instance_st memcached_instance_st -.. c:type:: struct memcached_server_list_st memcached_server_list_st - .. c:type:: struct memcached_server_st memcached_server_st +.. c:type:: struct memcached_server_st *memcached_server_list_st + .. function:: const memcached_instance_st * memcached_server_list (memcached_st *ptr) + :param ptr: pointer to initialized `memcached_st` struct + :returns: list of `memcached_instance_st` objects + .. function:: void memcached_server_list_free (memcached_server_list_st list) + :param list: + .. function:: memcached_server_list_st memcached_server_list_append (memcached_server_list_st list, const char *hostname, in_port_t port, memcached_return_t *error) .. function:: uint32_t memcached_server_list_count (memcached_server_list_st list) @@ -36,8 +41,7 @@ DESCRIPTION libmemcached(3) operates on a list of hosts which are stored in :type:`memcached_server_st` structures. You should not modify these structures -directly. Functions are provided to modify these structures (and more can be -added, just ask!). +directly. Functions are provided to modify these structures. :func:`memcached_server_list` is used to provide an array of all defined hosts. This was incorrectly documented as "requiring free" up till version 0.39.