boourns-memcached 1.4.6

data/ext/libmemcached-0.32/docs/memcached_stat_get_value.3

@@ -0,0 +1,204 @@
+.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
+.\"
+.\" 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 "..::docs::memcached_stats 3"
+.TH ..::docs::memcached_stats 3 "2012-10-24" "" "libmemcached"
+.\" 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_stat, memcached_stat_servername, memcached_stat_get_value, memcached_stat_get_keys \- Get memcached statistics
+.SH "LIBRARY"
+.IX Header "LIBRARY"
+C Client Library for memcached (libmemcached, \-lmemcached)
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+.Vb 1
+\&  #include <memcached.h>
+\&
+\&  memcached_stat_st *memcached_stat (memcached_st *ptr,
+\&                                     char *args,
+\&                                     memcached_return *error);
+\&
+\&  memcached_return memcached_stat_servername (memcached_stat_st *stat,
+\&                                              char *args, 
+\&                                              char *hostname,
+\&                                              unsigned int port);
+\&
+\&  char *memcached_stat_get_value (memcached_st *ptr,
+\&                                  memcached_stat_st *stat, 
+\&                                  char *key,
+\&                                  memcached_return *error);
+\&
+\&  char ** memcached_stat_get_keys (memcached_st *ptr,
+\&                                   memcached_stat_st *stat, 
+\&                                   memcached_return *error);
+.Ve
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+\&\fIlibmemcached\fR\|(3) has the ability to query a memcached server (or collection
+of servers) for their current state. Queries to find state return a
+\&\f(CW\*(C`memcached_stat_st\*(C'\fR structure. You are responsible for freeing this structure.
+While it is possible to access the structure directly it is not advisable.
+<\fImemcached_stat_get_value()\fR has been provided to query the structure.
+.PP
+\&\fImemcached_stat()\fR fetches an array of \f(CW\*(C`memcached_stat_st\*(C'\fR structures containing
+the state of all available memcached servers. The return value must be freed
+by the calling application. If called with the \f(CW\*(C`MEMCACHED_BEHAVIOR_USE_UDP\*(C'\fR
+behavior set, a \s-1NULL\s0 value is returned and the error parameter is set to 
+\&\f(CW\*(C`MEMCACHED_NOT_SUPPORTED\*(C'\fR.
+.PP
+\&\fImemcached_stat_servername()\fR can be used standalone without a \f(CW\*(C`memcached_st\*(C'\fR to
+obtain the state of a particular server.  \*(L"args\*(R" is used to define a
+particular state object (a list of these are not provided for by either
+the \fImemcached_stat_get_keys()\fR call nor are they defined in the memcached
+protocol). You must specify the hostname and port of the server you want to
+obtain information on.
+.PP
+\&\fImemcached_stat_get_value()\fR returns the value of a particular state key. You
+specify the key you wish to obtain.  The key must be null terminated.
+.PP
+\&\fImemcached_stat_get_keys()\fR returns a list of keys that the server has state
+objects on. You are responsible for freeing this list.
+.PP
+A command line tool, \fImemstat\fR\|(1), is provided so that you do not have to write
+an application to do this.
+.SH "RETURN"
+.IX Header "RETURN"
+Varies, see particular functions.
+.PP
+Any method returning a \f(CW\*(C`memcached_stat_st\*(C'\fR expects you to free the
+memory allocated for it.
+.SH "HOME"
+.IX Header "HOME"
+To find out more information please check:
+<http://tangent.org/552/libmemcached.html>
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+Brian Aker, <brian@tangent.org>
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+\&\fImemcached\fR\|(1) \fIlibmemcached\fR\|(3) \fImemcached_strerror\fR\|(3)

data/ext/libmemcached-0.32/docs/memcached_stat_servername.3

@@ -0,0 +1,204 @@
+.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
+.\"
+.\" 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 "..::docs::memcached_stats 3"
+.TH ..::docs::memcached_stats 3 "2012-10-24" "" "libmemcached"
+.\" 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_stat, memcached_stat_servername, memcached_stat_get_value, memcached_stat_get_keys \- Get memcached statistics
+.SH "LIBRARY"
+.IX Header "LIBRARY"
+C Client Library for memcached (libmemcached, \-lmemcached)
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+.Vb 1
+\&  #include <memcached.h>
+\&
+\&  memcached_stat_st *memcached_stat (memcached_st *ptr,
+\&                                     char *args,
+\&                                     memcached_return *error);
+\&
+\&  memcached_return memcached_stat_servername (memcached_stat_st *stat,
+\&                                              char *args, 
+\&                                              char *hostname,
+\&                                              unsigned int port);
+\&
+\&  char *memcached_stat_get_value (memcached_st *ptr,
+\&                                  memcached_stat_st *stat, 
+\&                                  char *key,
+\&                                  memcached_return *error);
+\&
+\&  char ** memcached_stat_get_keys (memcached_st *ptr,
+\&                                   memcached_stat_st *stat, 
+\&                                   memcached_return *error);
+.Ve
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+\&\fIlibmemcached\fR\|(3) has the ability to query a memcached server (or collection
+of servers) for their current state. Queries to find state return a
+\&\f(CW\*(C`memcached_stat_st\*(C'\fR structure. You are responsible for freeing this structure.
+While it is possible to access the structure directly it is not advisable.
+<\fImemcached_stat_get_value()\fR has been provided to query the structure.
+.PP
+\&\fImemcached_stat()\fR fetches an array of \f(CW\*(C`memcached_stat_st\*(C'\fR structures containing
+the state of all available memcached servers. The return value must be freed
+by the calling application. If called with the \f(CW\*(C`MEMCACHED_BEHAVIOR_USE_UDP\*(C'\fR
+behavior set, a \s-1NULL\s0 value is returned and the error parameter is set to 
+\&\f(CW\*(C`MEMCACHED_NOT_SUPPORTED\*(C'\fR.
+.PP
+\&\fImemcached_stat_servername()\fR can be used standalone without a \f(CW\*(C`memcached_st\*(C'\fR to
+obtain the state of a particular server.  \*(L"args\*(R" is used to define a
+particular state object (a list of these are not provided for by either
+the \fImemcached_stat_get_keys()\fR call nor are they defined in the memcached
+protocol). You must specify the hostname and port of the server you want to
+obtain information on.
+.PP
+\&\fImemcached_stat_get_value()\fR returns the value of a particular state key. You
+specify the key you wish to obtain.  The key must be null terminated.
+.PP
+\&\fImemcached_stat_get_keys()\fR returns a list of keys that the server has state
+objects on. You are responsible for freeing this list.
+.PP
+A command line tool, \fImemstat\fR\|(1), is provided so that you do not have to write
+an application to do this.
+.SH "RETURN"
+.IX Header "RETURN"
+Varies, see particular functions.
+.PP
+Any method returning a \f(CW\*(C`memcached_stat_st\*(C'\fR expects you to free the
+memory allocated for it.
+.SH "HOME"
+.IX Header "HOME"
+To find out more information please check:
+<http://tangent.org/552/libmemcached.html>
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+Brian Aker, <brian@tangent.org>
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+\&\fImemcached\fR\|(1) \fIlibmemcached\fR\|(3) \fImemcached_strerror\fR\|(3)

data/ext/libmemcached-0.32/docs/memcached_stats.pod

@@ -0,0 +1,82 @@
+=head1 NAME
+
+memcached_stat, memcached_stat_servername, memcached_stat_get_value, memcached_stat_get_keys - Get memcached statistics
+
+=head1 LIBRARY
+
+C Client Library for memcached (libmemcached, -lmemcached)
+
+=head1 SYNOPSIS
+
+  #include <memcached.h>
+
+  memcached_stat_st *memcached_stat (memcached_st *ptr,
+                                     char *args,
+                                     memcached_return *error);
+
+  memcached_return memcached_stat_servername (memcached_stat_st *stat,
+                                              char *args, 
+                                              char *hostname,
+                                              unsigned int port);
+
+  char *memcached_stat_get_value (memcached_st *ptr,
+                                  memcached_stat_st *stat, 
+                                  char *key,
+                                  memcached_return *error);
+
+  char ** memcached_stat_get_keys (memcached_st *ptr,
+                                   memcached_stat_st *stat, 
+                                   memcached_return *error);
+
+=head1 DESCRIPTION
+
+libmemcached(3) has the ability to query a memcached server (or collection
+of servers) for their current state. Queries to find state return a
+C<memcached_stat_st> structure. You are responsible for freeing this structure.
+While it is possible to access the structure directly it is not advisable.
+<memcached_stat_get_value() has been provided to query the structure.
+
+memcached_stat() fetches an array of C<memcached_stat_st> structures containing
+the state of all available memcached servers. The return value must be freed
+by the calling application. If called with the C<MEMCACHED_BEHAVIOR_USE_UDP>
+behavior set, a NULL value is returned and the error parameter is set to 
+C<MEMCACHED_NOT_SUPPORTED>.
+
+memcached_stat_servername() can be used standalone without a C<memcached_st> to
+obtain the state of a particular server.  "args" is used to define a
+particular state object (a list of these are not provided for by either
+the memcached_stat_get_keys() call nor are they defined in the memcached
+protocol). You must specify the hostname and port of the server you want to
+obtain information on.
+
+memcached_stat_get_value() returns the value of a particular state key. You
+specify the key you wish to obtain.  The key must be null terminated.
+
+memcached_stat_get_keys() returns a list of keys that the server has state
+objects on. You are responsible for freeing this list.
+
+A command line tool, memstat(1), is provided so that you do not have to write
+an application to do this.
+
+=head1 RETURN
+
+Varies, see particular functions.
+
+Any method returning a C<memcached_stat_st> expects you to free the
+memory allocated for it.
+
+=head1 HOME
+
+To find out more information please check:
+L<http://tangent.org/552/libmemcached.html>
+
+=head1 AUTHOR
+
+Brian Aker, E<lt>brian@tangent.orgE<gt>
+
+=head1 SEE ALSO
+
+memcached(1) libmemcached(3) memcached_strerror(3)
+
+=cut
+