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

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