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

   1 .TH "MEMCACHED_SET_SASL_CALLBACKS" "3" "July 21, 2011" "0.51" "libmemcached"
   2 .SH NAME
   3 memcached_set_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 SYNOPSIS
  34 .sp
  35 #include <libmemcached/memcached_pool.h>
  36 .INDENT 0.0
  37 .TP
  38 .B void memcached_set_sasl_callbacks(memcached_st\fI\ *ptr\fP, const sasl_callback_t\fI\ *callbacks\fP)
  39 .UNINDENT
  40 .INDENT 0.0
  41 .TP
  42 .B const sasl_callback_t *memcached_get_sasl_callbacks(memcached_st\fI\ *ptr\fP)
  43 .UNINDENT
  44 .INDENT 0.0
  45 .TP
  46 .B memcached_return memcached_set_sasl_auth_data(memcached_st\fI\ *ptr\fP, const char\fI\ *username\fP, const char\fI\ *password\fP)
  47 .UNINDENT
  48 .INDENT 0.0
  49 .TP
  50 .B memcached_return memcached_destroy_sasl_auth_data(memcached_st\fI\ *ptr\fP)
  51 .UNINDENT
  52 .sp
  53 Compile and link with \-lmemcached
  54 .SH DESCRIPTION
  55 .sp
  56 libmemcached(3) allows you to plug in your own callbacks function used by
  57 libsasl to perform SASL authentication.
  58 .sp
  59 Please note that SASL requires the memcached binary protocol, and you have
  60 to specify the callbacks before you connect to the server.
  61 .sp
  62 \fI\%memcached_set_sasl_auth_data()\fP is a helper function defining
  63 the basic functionality for you, but it will store the username and password
  64 in memory. If you choose to use this method you have to call
  65 \fI\%memcached_destroy_sasl_auth_data\fP before calling
  66 \fBmemcached_free\fP to avoid a memory leak. You should NOT call
  67 \fI\%memcached_destroy_sasl_auth_data\fP if you specify your own callback
  68 function with \fI\%memcached_set_sasl_callbacks()\fP.
  69 .sp
  70 You as a client user have to initialize libsasl by using \fBsasl_client_init\fP before enabling it in libmemcached, and you have to shut down libsasl by
  71 calling \fBsasl_done()\fP when you are done using SASL from libmemcached.
  72 .SH RETURN
  73 .sp
  74 \fI\%memcached_get_sasl_callbacks()\fP returns the callbacks currently used
  75 by this memcached handle. \fBmemcached_get_sasl_set_auth_data()\fP returns \fBMEMCACHED_SUCCESS\fP 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 .