Wiping clean the contents of a server — libmemcached-awesome 1.1.4 documentation

# Wiping clean the contents of a server

## SYNOPSIS

#include <libmemcached/memcached.h>

  Compile and link with -lmemcached

memcached_return_t memcached_flush(memcached_st *ptr, time_t expiration)
  Parameters:

    - ptr -- pointer to an initialized `memcached_st` struct

    - expiration -- expiration as a unix timestamp or as relative expiration time in seconds

  Returns:

    `memcached_return_t` indicating success

## DESCRIPTION

`memcached_flush()` is used to wipe clean the contents of memcached(1) servers. It will either do this immediately or expire the content based on the expiration time passed to the method (a value of zero causes an immediate flush). The operation is not atomic to multiple servers, just atomic to a single server. That is, it will flush the servers in the order that they were added.

## RETURN VALUE

A value of type `memcached_return_t` is returned. On success that value will be `MEMCACHED_SUCCESS`. Use `memcached_strerror()` to translate this value to a printable string.

## SEE ALSO

- memcached(1)

- C/C++ Client Library for memcached

- Converting Error Codes to Messages