← Back to branch summary

~brianaker/libmemcached/1164440

« back to all changes in this revision

Viewing changes to docs/memcached_version.pod

Merging bzr://gaz.tangent.org/libmemcached/build/ to Build branch

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/memcached_version.pod
1
 
=head1 NAME
2
 
 
3
 
memcached_lib_version
4
 
 
5
 
memcached_version
6
 
 
7
 
=head1 LIBRARY
8
 
 
9
 
C Client Library for memcached (libmemcached, -lmemcached)
10
 
 
11
 
=head1 SYNOPSIS
12
 
 
13
 
  #include <memcached.h>
14
 
 
15
 
  const char *
16
 
    memcached_lib_version(void) 
17
 
 
18
 
 
19
 
  memcached_return
20
 
    memcached_version(memcached_st *ptr)
21
 
 
22
 
 
23
 
=head1 DESCRIPTION
24
 
 
25
 
memcached_lib_version() is used to return a simple version string representing
26
 
the libmemcached version (version of the client library, not server)
27
 
 
28
 
 
29
 
memcached_version() is used to set the major, minor, and micro versions of each
30
 
memcached server being used by the memcached_st connection structure. It returns the 
31
 
memcached server return code. 
32
 
 
33
 
=head1 RETURN
34
 
 
35
 
A string with the version of libmemcached driver is returned from
36
 
memcached_lib_version()
37
 
 
38
 
A value of type C<memcached_return> is returned from memcached_version()
39
 
On success that value will be C<MEMCACHED_SUCCESS>.
40
 
Use memcached_strerror() to translate this value to a printable string.
41
 
 
42
 
=head1 HOME
43
 
 
44
 
To find out more information please check:
45
 
L<http://tangent.org/552/libmemcached.html>
46
 
 
47
 
=head1 AUTHOR
48
 
 
49
 
Brian Aker, E<lt>brian@tangent.orgE<gt>
50
 
 
51
 
=head1 SEE ALSO
52
 
 
53
 
memcached(1) libmemcached(3) memcached_strerror(3)
54
 
 
55
 
=cut
56