Tar Archive: /hpux/Misc/libmemcached-0.46/libmemcached-0.46-hppa_32-11.23.depot.gz
Filename: libmemcached/libmemcached-MAN/usr/local/share/man/man3/memcached_server_list.3
.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "memcached_server_list.pop 3"
.TH memcached_server_list.pop 3 "2010-06-28" "" "memcached_server_list"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
memcached_server_count, memcached_server_list, memcached_server_add, memcached_server_push, memcached_server_get_last_disconnect, memcached_server_cursor \- Manage server list
.SH "LIBRARY"
.IX Header "LIBRARY"
C Client Library for memcached (libmemcached, \-lmemcached)
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& #include
\&
\& uint32_t memcached_server_count (memcached_st *ptr);
\&
\& memcached_return_t
\& memcached_server_add (memcached_st *ptr,
\& const char *hostname,
\& in_port_t port);
\&
\& memcached_return_t
\& memcached_server_add_udp (memcached_st *ptr,
\& const char *hostname,
\& in_port_t port);
\&
\& memcached_return_t
\& memcached_server_add_unix_socket (memcached_st *ptr,
\& const char *socket);
\&
\& memcached_return_t
\& memcached_server_push (memcached_st *ptr,
\& const memcached_server_st *list);
\&
\& memcached_server_instance_st
\& memcached_server_by_key (const memcached_st *ptr,
\& const char *key,
\& size_t key_length,
\& memcached_return_t *error);
\&
\& memcached_server_instance_st
\& memcached_server_get_last_disconnect (const memcached_st *ptr)
\&
\& memcached_return_t
\& memcached_server_cursor(const memcached_st *ptr,
\& const memcached_server_fn *callback,
\& void *context,
\& uint32_t number_of_callbacks);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fIlibmemcached\fR\|(3) performs operations on a list of hosts. The order of these
hosts determine routing to keys. Functions are provided to add keys to
memcached_st structures. To manipulate lists of servers see
\&\fImemcached_server_st\fR\|(3).
.PP
\&\fImemcached_server_count()\fR provides you a count of the current number of
servers being used by a \f(CW\*(C`memcached_st\*(C'\fR structure.
.PP
\&\fImemcached_server_add()\fR pushes a single \s-1TCP\s0 server into the \f(CW\*(C`memcached_st\*(C'\fR
structure. This server will be placed at the end. Duplicate servers are
allowed, so duplication is not checked. Executing this function with the
\&\f(CW\*(C`MEMCACHED_BEHAVIOR_USE_UDP\*(C'\fR behavior set will result in a
\&\f(CW\*(C`MEMCACHED_INVALID_HOST_PROTOCOL\*(C'\fR.
.PP
\&\fImemcached_server_add_udp()\fR pushes a single \s-1UDP\s0 server into the \f(CW\*(C`memcached_st\*(C'\fR
structure. This server will be placed at the end. Duplicate servers are
allowed, so duplication is not checked. Executing this function with out
setting the \f(CW\*(C`MEMCACHED_BEHAVIOR_USE_UDP\*(C'\fR behavior will result in a
\&\f(CW\*(C`MEMCACHED_INVALID_HOST_PROTOCOL\*(C'\fR.
.PP
\&\fImemcached_server_add_unix_socket()\fR pushes a single \s-1UNIX\s0 socket into the
\&\f(CW\*(C`memcached_st\*(C'\fR structure. This \s-1UNIX\s0 socket will be placed at the end.
Duplicate servers are allowed, so duplication is not checked. The length
of the filename must be one character less then \s-1MEMCACHED_MAX_HOST_LENGTH\s0.
.PP
\&\fImemcached_server_push()\fR pushes an array of \f(CW\*(C`memcached_server_st\*(C'\fR into
the \f(CW\*(C`memcached_st\*(C'\fR structure. These servers will be placed at the
end. Duplicate servers are allowed, so duplication is not checked. A
copy is made of structure so the list provided (and any operations on
the list) are not saved.
.PP
\&\fImemcached_server_by_key()\fR allows you to provide a key and retrieve the
server which would be used for assignment. This structure is cloned
from its original structure and must be freed. If \s-1NULL\s0 is returned you
should consult *error. The returning structure should be freed with
\&\fImemcached_server_free()\fR.
.PP
\&\fImemcached_server_get_last_disconnect()\fR returns a pointer to the last server
for which there was a connection problem. It does not mean this particular
server is currently dead but if the library is reporting a server is,
the returned server is a very good candidate.
.PP
\&\fImemcached_server_cursor()\fR takes a memcached_st and loops through the
list of hosts currently in the cursor calling the list of callback
functions provided. You can optionally pass in a value via
context which will be provided to each callback function. An error
return from any callback will terminate the loop. \fImemcached_server_cursor()\fR
is passed the original caller memcached_st in its current state.
.SH "RETURN"
.IX Header "RETURN"
Varies, see particular functions.
.SH "HOME"
.IX Header "HOME"
To find out more information please check:
.SH "AUTHOR"
.IX Header "AUTHOR"
Brian Aker,
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fImemcached\fR\|(1) \fIlibmemcached\fR\|(3) \fImemcached_strerror\fR\|(3)