diff options
| author | Continuous Integration <ci@tangent.org> | 2014-02-16 03:31:37 -0800 |
|---|---|---|
| committer | Continuous Integration <ci@tangent.org> | 2014-02-16 03:31:37 -0800 |
| commit | b163cbc1e82ea834b66e3b4c1e8070394ccb506d (patch) | |
| tree | 999734df2e2c288d6726af31f9336beadb2a781a /docs/source/libmemcached-1.0 | |
| parent | 8541a9863cffad457f4d583af6a6c3613250193d (diff) | |
| parent | 37deb7fa75a0b3fbea4d58c032446213f0d5a02a (diff) | |
| download | libmemcached-trunk.tar.gz | |
Diffstat (limited to 'docs/source/libmemcached-1.0')
| -rw-r--r-- | docs/source/libmemcached-1.0/index.rst | 9 | ||||
| -rw-r--r-- | docs/source/libmemcached-1.0/memcached_set_encoding_key.rst | 58 | ||||
| -rw-r--r-- | docs/source/libmemcached-1.0/memcached_touch.rst | 61 |
3 files changed, 128 insertions, 0 deletions
diff --git a/docs/source/libmemcached-1.0/index.rst b/docs/source/libmemcached-1.0/index.rst new file mode 100644 index 00000000..fb8ed307 --- /dev/null +++ b/docs/source/libmemcached-1.0/index.rst @@ -0,0 +1,9 @@ +==================== +libmemcached 1.0 API +==================== + + +.. toctree:: + :titlesonly: + + memcached_touch diff --git a/docs/source/libmemcached-1.0/memcached_set_encoding_key.rst b/docs/source/libmemcached-1.0/memcached_set_encoding_key.rst new file mode 100644 index 00000000..be38b03f --- /dev/null +++ b/docs/source/libmemcached-1.0/memcached_set_encoding_key.rst @@ -0,0 +1,58 @@ +================== +Set encryption key +================== + +.. index:: object: memcached_st + +-------- +SYNOPSIS +-------- + +#include <libmemcached/memcached.h> + +.. c:function:: void memcached_set_encoding_key (memcached_st *ptr, const char *string, const size_t string_length) + +Compile and link with -lmemcached + +----------- +DESCRIPTION +----------- + + +:c:func:`memcached_set_encoding_key` sets the key that will be used to encrypt and decrypt data as it is sent and recieved from the server. + +Currently only AES is is supported. + + +------ +RETURN +------ + + +A value of type :c:type:`memcached_return_t` is returned On success that value +will be :c:type:`MEMCACHED_SUCCESS`. Use :c:func:`memcached_strerror` to +translate this value to a printable string. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ <http://libmemcached.org/>`_ + + +------ +AUTHOR +------ + + +Brian Aker, <brian@tangent.org> + + +-------- +SEE ALSO +-------- + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/source/libmemcached-1.0/memcached_touch.rst b/docs/source/libmemcached-1.0/memcached_touch.rst new file mode 100644 index 00000000..76b015cb --- /dev/null +++ b/docs/source/libmemcached-1.0/memcached_touch.rst @@ -0,0 +1,61 @@ +=========================================== +memcached_touch, memcached_touch_by_key +=========================================== + +.. index:: object: memcached_st + +-------- +SYNOPSIS +-------- + + +#include <libmemcached/memcached.h> + +.. c:function:: memcached_return_t memcached_touch (memcached_st *ptr, const char *key, size_t key_length, time_t expiration) + +.. c:function:: memcached_return_t memcached_touch_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration) + +Compile and link with -lmemcached + +----------- +DESCRIPTION +----------- + + +:c:func:`memcached_touch` is used to update the expiration time on an existing key. +:c:func:`memcached_touch_by_key` works the same, but it takes a master key +to find the given value. + + +------ +RETURN +------ + + +A value of type :c:type:`memcached_return_t` is returned +On success that value will be :c:type:`MEMCACHED_SUCCESS`. +Use :c:func:`memcached_strerror` to translate this value to a printable +string. + +---- +HOME +---- + +To find out more information please check: +`http://libmemcached.org/ <http://libmemcached.org/>`_ + + +------ +AUTHOR +------ + + +Brian Aker, <brian@tangent.org> + + +-------- +SEE ALSO +-------- + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + |