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

   1 .TH "MEMCACHED_SERVER_ADD_UNIX_SOCKET" "3" "June 02, 2011" "0.47" "libmemcached"
   2 .SH NAME
   3 memcached_server_add_unix_socket \- 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 uint32_t memcached_server_count (memcached_st *ptr);
  39 .UNINDENT
  40 .INDENT 0.0
  41 .TP
  42 .B memcached_return_t memcached_server_add (memcached_st *ptr, const char *hostname, in_port_t port);
  43 .UNINDENT
  44 .INDENT 0.0
  45 .TP
  46 .B memcached_return_t memcached_server_add_udp (memcached_st *ptr, const char *hostname, in_port_t port);
  47 .UNINDENT
  48 .INDENT 0.0
  49 .TP
  50 .B memcached_return_t memcached_server_add_unix_socket (memcached_st *ptr, const char *socket);
  51 .UNINDENT
  52 .INDENT 0.0
  53 .TP
  54 .B memcached_return_t memcached_server_push (memcached_st *ptr, const memcached_server_st *list);
  55 .UNINDENT
  56 .INDENT 0.0
  57 .TP
  58 .B memcached_server_instance_st memcached_server_by_key (const memcached_st *ptr, const char *key, size_t key_length, memcached_return_t *error);
  59 .UNINDENT
  60 .INDENT 0.0
  61 .TP
  62 .B memcached_server_instance_st memcached_server_get_last_disconnect(const memcached_st\fI\ *ptr\fP)
  63 .UNINDENT
  64 .INDENT 0.0
  65 .TP
  66 .B memcached_return_t memcached_server_cursor(const memcached_st *ptr, const memcached_server_fn *callback, void *context, uint32_t number_of_callbacks);
  67 .UNINDENT
  68 .sp
  69 compile and link with \-lmemcached
  70 .SH DESCRIPTION
  71 .sp
  72 libmemcached(3) performs operations on a list of hosts. The order of these
  73 hosts determine routing to keys. Functions are provided to add keys to
  74 memcached_st structures. To manipulate lists of servers see
  75 memcached_server_st(3).
  76 .sp
  77 memcached_server_count() provides you a count of the current number of
  78 servers being used by a \fBmemcached_st\fP structure.
  79 .sp
  80 memcached_server_add() pushes a single TCP server into the \fBmemcached_st\fPstructure. This server will be placed at the end. Duplicate servers are
  81 allowed, so duplication is not checked. Executing this function with the
  82 \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior set will result in a
  83 \fBMEMCACHED_INVALID_HOST_PROTOCOL\fP.
  84 .sp
  85 memcached_server_add_udp() pushes a single UDP server into the \fBmemcached_st\fPstructure. This server will be placed at the end. Duplicate servers are
  86 allowed, so duplication is not checked. Executing this function with out
  87 setting the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior will result in a
  88 \fBMEMCACHED_INVALID_HOST_PROTOCOL\fP.
  89 .sp
  90 memcached_server_add_unix_socket() pushes a single UNIX socket into the
  91 \fBmemcached_st\fP structure. This UNIX socket will be placed at the end.
  92 Duplicate servers are allowed, so duplication is not checked. The length
  93 of the filename must be one character less then MEMCACHED_MAX_HOST_LENGTH.
  94 .sp
  95 memcached_server_push() pushes an array of \fBmemcached_server_st\fP into
  96 the \fBmemcached_st\fP structure. These servers will be placed at the
  97 end. Duplicate servers are allowed, so duplication is not checked. A
  98 copy is made of structure so the list provided (and any operations on
  99 the list) are not saved.
 100 .sp
 101 memcached_server_by_key() allows you to provide a key and retrieve the
 102 server which would be used for assignment. This structure is cloned
 103 from its original structure and must be freed. If NULL is returned you
 104 should consult *error. The returning structure should be freed with
 105 memcached_server_free().
 106 .sp
 107 memcached_server_get_last_disconnect() returns a pointer to the last server
 108 for which there was a connection problem. It does not mean this particular
 109 server is currently dead but if the library is reporting a server is,
 110 the returned server is a very good candidate.
 111 .sp
 112 memcached_server_cursor() takes a memcached_st and loops through the
 113 list of hosts currently in the cursor calling the list of callback
 114 functions provided. You can optionally pass in a value via
 115 context which will be provided to each callback function. An error
 116 return from any callback will terminate the loop. memcached_server_cursor()
 117 is passed the original caller memcached_st in its current state.
 118 .SH RETURN
 119 .sp
 120 Varies, see particular functions.
 121 .SH HOME
 122 .sp
 123 To find out more information please check:
 124 \fI\%http://libmemcached.org/\fP
 125 .SH SEE ALSO
 126 .sp
 127 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
 128 .SH AUTHOR
 129 Brian Aker
 130 .SH COPYRIGHT
 131 2011, Brian Aker DataDifferential, http://datadifferential.com/
 132 .\" Generated by docutils manpage writer.
 133 .\"
 134 .