← Back to branch summary

~avsej/libmemcached/touch-command

« back to all changes in this revision

Viewing changes to docs/man/memcached_set_sasl_callbacks.3

  • Committer: Brian Aker
  • Date: 2011-05-24 20:43:14 UTC
  • mfrom: (929.1.110 libmemcached-build)
  • Revision ID: brian@tangent.org-20110524204314-9ag1kkk4c1a6b3z3
Merge in local trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/man/memcached_set_sasl_callbacks.3
1
 
.TH "MEMCACHED_SET_SASL_CALLBACKS" "3" "April 14, 2011" "0.47" "libmemcached"
 
1
.TH "MEMCACHED_SET_SASL_CALLBACKS" "3" "May 23, 2011" "0.47" "libmemcached"
2
2
.SH NAME
3
3
memcached_set_sasl_callbacks \- libmemcached Documentation
4
4
.
30
30
..
31
31
.\" Man page generated from reStructeredText.
32
32
.
33
 
.SH LIBRARY
34
 
.sp
35
 
C Client Library for memcached (libmemcached, \-lmemcached)
36
33
.SH SYNOPSIS
37
34
.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
 
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
53
54
.SH DESCRIPTION
54
55
.sp
55
56
libmemcached(3) allows you to plug in your own callbacks function used by
58
59
Please note that SASL requires the memcached binary protocol, and you have
59
60
to specify the callbacks before you connect to the server.
60
61
.sp
61
 
memcached_set_sasl_auth_data() is a helper function for you defining
 
62
memcached_set_sasl_auth_data() is a helper function defining
62
63
the basic functionality for you, but it will store the username and password
63
64
in memory. If you choose to use this method you have to call
64
65
memcached_destroy_sasl_auth_data before calling memcached_free to avoid