git.m6w6.name Git - awesomized/libmemcached/blob - docs/memcached_create.pod

   1 =head1 NAME
   2
   3 memcached_create, memcached_free
   4
   5 =head1 LIBRARY
   6
   7 C Client Library for memcached (libmemcached, -lmemcached)
   8
   9 =head1 SYNOPSIS
  10
  11   #include <memcached.h>
  12
  13   memcached_st *memcached_create (memcached_st *ptr);
  14
  15   void memcached_free (memcached_st *ptr);
  16
  17 =head1 DESCRIPTION
  18
  19 memcached_create() is used to create a C<memcached_st> structure that will then
  20 be used by other libmemcached(3) functions to communicate with the server. You
  21 should either pass a statically declared C<memcached_st> to memcached_create() or
  22 a NULL. If a NULL passed in then a structure is allocated for you.
  23
  24 To clean up memory associated with a C<memcached_st> structure you should pass
  25 it to memcached_free() when you are finished using it. memcached_free() is
  26 the only way to make sure all memory is deallocated when you finish using
  27 the structure.
  28
  29 =head1 RETURN
  30
  31 memcached_create() returns a pointer to the memcached_st that was created
  32 (or initialized). On an allocation failure, it returns NULL.
  33
  34 =head1 HOME
  35
  36 To find out more information please check:
  37 L<http://tangent.org/552/libmemcached.html>
  38
  39 =head1 AUTHOR
  40
  41 Brian Aker, E<lt>brian@tangent.orgE<gt>
  42
  43 =head1 SEE ALSO
  44
  45 memcached(1) libmemcached(3) memcached_strerror(3)
  46
  47 =cut
  48