git.m6w6.name Git - m6w6/libmemcached/blob - docs/man/memcached_server_list_free.3

   1 .TH "MEMCACHED_SERVER_LIST_FREE" "3" "April 11, 2011" "0.47" "libmemcached"
   2 .SH NAME
   3 memcached_server_list_free \- libmemcached Documentation
   4 .
   5 .nr rst2man-indent-level 0
   6 .
   7 .de1 rstReportMargin
   8 \\$1 \\n[an-margin]
   9 level \\n[rst2man-indent-level]
  10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  11 -
  12 \\n[rst2man-indent0]
  13 \\n[rst2man-indent1]
  14 \\n[rst2man-indent2]
  15 ..
  16 .de1 INDENT
  17 .\" .rstReportMargin pre:
  18 . RS \\$1
  19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  20 . nr rst2man-indent-level +1
  21 .\" .rstReportMargin post:
  22 ..
  23 .de UNINDENT
  24 . RE
  25 .\" indent \\n[an-margin]
  26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  27 .nr rst2man-indent-level -1
  28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  30 ..
  31 .\" Man page generated from reStructeredText.
  32 .
  33 .sp
  34 Manage server list
  35 .SH LIBRARY
  36 .sp
  37 C Client Library for memcached (libmemcached, \-lmemcached)
  38 .SS SYNOPSIS
  39 .sp
  40 .nf
  41 .ft C
  42 #include <libmemcached/memcached.h>
  43
  44 const memcached_server_instance_st
  45   memcached_server_list (memcached_st *ptr);
  46
  47 void memcached_server_list_free (memcached_server_list_st list);
  48
  49 memcached_server_list_st
  50   memcached_server_list_append (memcached_server_list_st list,
  51                                 const char *hostname,
  52                                 unsigned int port,
  53                                 memcached_return_t *error);
  54
  55 uint32_t memcached_server_list_count (memcached_server_list_st list);
  56
  57 memcached_server_list_st memcached_servers_parse (const char *server_strings);
  58
  59 const char *memcached_server_error (memcached_server_instance_st instance);
  60
  61 DEPRECATED
  62 void memcached_server_error_reset (memcached_server_instance_st list);
  63 .ft P
  64 .fi
  65 .SS DESCRIPTION
  66 .sp
  67 libmemcached(3) operates on a list of hosts which are stored in
  68 memcached_server_st structures. You should not modify these structures
  69 directly. Functions are provided to modify these structures (and more can be
  70 added, just ask!).
  71 .sp
  72 memcached_server_list() is used to provide an array of all defined hosts.
  73 This was incorrectly documented as "requiring free()" up till version 0.39.
  74 .sp
  75 memcached_server_list_free() deallocates all memory associated with the array
  76 of memcached_server_st that you passed to it.
  77 .sp
  78 memcached_server_list_append() adds a server to the end of a
  79 memcached_server_st array. On error null will be returned and the
  80 memcached_return_t pointer you passed into the function will be set with the
  81 appropriate error. If the value of port is zero, it is set to the default
  82 port of a memcached server.
  83 .sp
  84 memcached_servers_parse() takes a string, the type that is used for the
  85 command line applications, and parse it to an array of memcached_server_st.
  86 The example is "localhost, foo:555, foo, bar". All hosts except foo:555 will
  87 be set to the default port, while that host will have a port of 555.
  88 .sp
  89 memcached_server_error() can be used to look at the text of the last error
  90 message sent by the server to to the client.
  91 .sp
  92 Before version 0.39 theses functions used a memcache_server_st *. In 0.39
  93 memcached_server_st * was aliased to memcached_server_list_st. This was
  94 done for a style reason/to help clean up some concepts in the code.
  95 .SH RETURN
  96 .sp
  97 Varies, see particular functions.
  98 .SH HOME
  99 .sp
 100 To find out more information please check:
 101 \fI\%https://launchpad.net/libmemcached\fP
 102 .SH AUTHOR
 103 .sp
 104 Brian Aker, <\fI\%brian@tangent.org\fP>
 105 .SS SEE ALSO
 106 .sp
 107 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
 108 .SH AUTHOR
 109 Brian Aker
 110 .SH COPYRIGHT
 111 2011, Brian Aker DataDifferential, http://datadifferential.com/
 112 .\" Generated by docutils manpage writer.
 113 .\"
 114 .