X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_server_st.rst;h=6300879576f77ff8eb52d66760b7a72065e7775a;hb=a909573e5e57f8a6ee92cf4ffb031b9762642d1b;hp=e7ec65c97ac938d225080299f79dbdd5046e4750;hpb=02981035b5d948b8845ab08349afbd26b5f0a69c;p=awesomized%2Flibmemcached diff --git a/docs/memcached_server_st.rst b/docs/memcached_server_st.rst index e7ec65c9..63008795 100644 --- a/docs/memcached_server_st.rst +++ b/docs/memcached_server_st.rst @@ -11,21 +11,27 @@ SYNOPSIS #include -.. c:type:: memcached_server_instance_st +.. c:type:: const memcached_instance_st * -.. c:function:: const memcached_server_instance_st memcached_server_list (memcached_st *ptr) +.. c:type:: memcached_server_list_st + +.. c:type:: memcached_server_st + +.. c:function:: const const memcached_instance_st * memcached_server_list (memcached_st *ptr) .. c:function:: void memcached_server_list_free (memcached_server_list_st list) -.. c:function:: memcached_server_list_st memcached_server_list_append (memcached_server_list_st list, const char *hostname, unsigned int port, memcached_return_t *error) +.. c: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) .. c:function:: uint32_t memcached_server_list_count (memcached_server_list_st list) -.. c:function:: const char *memcached_server_error (memcached_server_instance_st instance) +.. c:function:: const char *memcached_server_error (const memcached_instance_st * instance) -.. c:function:: void memcached_server_error_reset (memcached_server_instance_st list) +.. c:function:: void memcached_server_error_reset (const memcached_instance_st * list) .. deprecated:: 0.39 +.. c:function:: void memcached_servers_parse () +.. deprecated:: 0.39 Compile and link with -lmemcached @@ -36,30 +42,25 @@ DESCRIPTION libmemcached(3) operates on a list of hosts which are stored in -memcached_server_st structures. You should not modify these structures +:c: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!). -:c: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. +:c: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. -:c:func:`memcached_server_list_free()` deallocates all memory associated with the array -of memcached_server_st that you passed to it. +:c:func:`memcached_server_list_free` deallocates all memory associated with the array of :c:type:`memcached_server_st` that you passed to it. -:c:func:`memcached_server_list_append()` adds a server to the end of a -memcached_server_st array. On error null will be returned and the -memcached_return_t pointer you passed into the function will be set with the -appropriate error. If the value of port is zero, it is set to the default +:c:func:`memcached_server_list_append` adds a server to the end of a +:c:type:`memcached_server_st` array. On error null will be returned and the +:c:type:`memcached_return_t` pointer you passed into the function will be set with the appropriate error. If the value of port is zero, it is set to the default port of a memcached server. -DEPRECATED :c:func:`memcached_servers_parse()`, please see :c:func:`memcached()` +DEPRECATED :c:func:`memcached_servers_parse`, please see :c:func:`memcached` -:c:func:`memcached_server_error()` can be used to look at the text of the last error -message sent by the server to to the client. +:c:func:`memcached_server_error` can be used to look at the text of the last error message sent by the server to to the client. -Before version 0.39 these functions used a memcache_server_st \*. In 0.39 -memcached_server_st \* was aliased to :c:type:`memcached_server_list_st`. This was -done for a style reason/to help clean up some concepts in the code. +Before version 0.39 theses functions used a memcache_server_st \*. In 0.39 +memcached_server_st \* was aliased to :c:type:`memcached_server_list_st`. This was done for a style reason to help clean up some concepts in the code. ------