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

   1 .TH "MEMCACHED_SERVERS_PARSE" "3" "June 10, 2011" "0.47" "libmemcached"
   2 .SH NAME
   3 memcached_servers_parse \- 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 .SH SYNOPSIS
  34 .sp
  35 #include <libmemcached/memcached.h>
  36 .INDENT 0.0
  37 .TP
  38 .B const memcached_server_instance_st memcached_server_list (memcached_st *ptr);
  39 .UNINDENT
  40 .INDENT 0.0
  41 .TP
  42 .B void memcached_server_list_free (memcached_server_list_st list);
  43 .UNINDENT
  44 .INDENT 0.0
  45 .TP
  46 .B memcached_server_list_st memcached_server_list_append (memcached_server_list_st list, const char *hostname, unsigned int port, memcached_return_t *error);
  47 .UNINDENT
  48 .INDENT 0.0
  49 .TP
  50 .B uint32_t memcached_server_list_count (memcached_server_list_st list);
  51 .UNINDENT
  52 .INDENT 0.0
  53 .TP
  54 .B const char *memcached_server_error (memcached_server_instance_st instance);
  55 .UNINDENT
  56 .INDENT 0.0
  57 .TP
  58 .B void memcached_server_error_reset (memcached_server_instance_st list); DEPRECATED
  59 .UNINDENT
  60 .sp
  61 Compile and link with \-lmemcached
  62 .SH DESCRIPTION
  63 .sp
  64 libmemcached(3) operates on a list of hosts which are stored in
  65 memcached_server_st structures. You should not modify these structures
  66 directly. Functions are provided to modify these structures (and more can be
  67 added, just ask!).
  68 .sp
  69 memcached_server_list() is used to provide an array of all defined hosts.
  70 This was incorrectly documented as "requiring free()" up till version 0.39.
  71 .sp
  72 memcached_server_list_free() deallocates all memory associated with the array
  73 of memcached_server_st that you passed to it.
  74 .sp
  75 memcached_server_list_append() adds a server to the end of a
  76 memcached_server_st array. On error null will be returned and the
  77 memcached_return_t pointer you passed into the function will be set with the
  78 appropriate error. If the value of port is zero, it is set to the default
  79 port of a memcached server.
  80 .sp
  81 DEPRECATED memcached_servers_parse(), please see \fImemcached(3)\fP
  82 .sp
  83 memcached_server_error() can be used to look at the text of the last error
  84 message sent by the server to to the client.
  85 .sp
  86 Before version 0.39 theses functions used a memcache_server_st *. In 0.39
  87 memcached_server_st * was aliased to memcached_server_list_st. This was
  88 done for a style reason/to help clean up some concepts in the code.
  89 .SH RETURN
  90 .sp
  91 Varies, see particular functions.
  92 .SH HOME
  93 .sp
  94 To find out more information please check:
  95 \fI\%http://libmemcached.org/\fP
  96 .SH SEE ALSO
  97 .sp
  98 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
  99 .SH AUTHOR
 100 Brian Aker
 101 .SH COPYRIGHT
 102 2011, Brian Aker DataDifferential, http://datadifferential.com/
 103 .\" Generated by docutils manpage writer.
 104 .\"
 105 .