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

   1 .TH "MEMCACHED_GET_SASL_CALLBACKS" "3" "April 14, 2011" "0.47" "libmemcached"
   2 .SH NAME
   3 memcached_get_sasl_callbacks \- 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 LIBRARY
  34 .sp
  35 C Client Library for memcached (libmemcached, \-lmemcached)
  36 .SH SYNOPSIS
  37 .sp
  38 .nf
  39 .ft C
  40 #include <libmemcached/memcached.h>
  41
  42 void memcached_set_sasl_callbacks(memcached_st *ptr,
  43                                   const sasl_callback_t *callbacks)
  44
  45 const sasl_callback_t *memcached_get_sasl_callbacks(memcached_st *ptr)
  46
  47 memcached_return memcached_set_sasl_auth_data(memcached_st *ptr,
  48                                               const char *username,
  49                                               const char *password)
  50 memcached_return memcached_destroy_sasl_auth_data(memcached_st *ptr)
  51 .ft P
  52 .fi
  53 .SH DESCRIPTION
  54 .sp
  55 libmemcached(3) allows you to plug in your own callbacks function used by
  56 libsasl to perform SASL authentication.
  57 .sp
  58 Please note that SASL requires the memcached binary protocol, and you have
  59 to specify the callbacks before you connect to the server.
  60 .sp
  61 memcached_set_sasl_auth_data() is a helper function for you defining
  62 the basic functionality for you, but it will store the username and password
  63 in memory. If you choose to use this method you have to call
  64 memcached_destroy_sasl_auth_data before calling memcached_free to avoid
  65 a memory leak. You should NOT call memcached_destroy_sasl_auth_data if you
  66 specify your own callback function with memcached_set_sasl_callbacks().
  67 .sp
  68 You as a client user have to initialize libsasl by using sasl_client_init
  69 before enabling it in libmemcached, and you have to shut down libsasl by
  70 calling sasl_done() when you are done using SASL from libmemcached.
  71 .SH RETURN
  72 .sp
  73 memcached_get_sasl_callbacks() returns the callbacks currently used
  74 by this memcached handle.
  75 memcached_get_sasl_set_auth_data() returns MEMCACHED_SUCCESS upon success.
  76 .SH HOME
  77 .sp
  78 To find out more information please check:
  79 \fI\%http://libmemcached.org/\fP
  80 .SH AUTHOR
  81 .sp
  82 Brian Aker, <\fI\%brian@tangent.org\fP>
  83 .sp
  84 Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
  85 .SH SEE ALSO
  86 .sp
  87 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
  88 .SH AUTHOR
  89 Brian Aker
  90 .SH COPYRIGHT
  91 2011, Brian Aker DataDifferential, http://datadifferential.com/
  92 .\" Generated by docutils manpage writer.
  93 .\"
  94 .