Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MEMCACHED(3)			 libmemcached			  MEMCACHED(3)

NAME
       memcached - libmemcached	Documentation

SYNOPSIS
       #include	<libmemcached-1.0/memcached.h>

       LIBMEMCACHED

       memcached_st *memcached(const char *string, size_t string_length)

       memcached_return_t   libmemcached_check_configuration(const   char *op-
       tion_string,   size_t length,   char *error_buffer,   size_t error_buf-
       fer_size)

       Compile and link	with -lmemcached

DESCRIPTION
       Libmemcached implements a custom	language for configuring and modifying
       servers.	By passing in an option	string you can generate	a memcached_st
       object that you can use in your application directly.

       --SERVER=<servername>:<optional_port>/?<optional_weight>

       Provide	a servername to	be used	by the client. Providing a weight will
       cause weighting to occur	with all hosts with each server	getting	a  de-
       fault weight of 1.

       --SOCKET="<filepath>/?<optional_weight>"

       Provide a filepath to a UNIX socket file. Providing a weight will cause
       weighting to occur with all hosts with each server  getting  a  default
       weight of 1.

       --VERIFY-KEY

       Verify  that keys that are being	used fit within	the design of the pro-
       tocol being used.

       --REMOVE_FAILED_SERVERS

       Enable the behavior MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS.

       --BINARY-PROTOCOL

       Force all connections to	use the	binary protocol.

       --BUFFER-REQUESTS

       Please see MEMCACHED_BEHAVIOR_BUFFER_REQUESTS.

       --CONFIGURE-FILE=

       Provide a configuration file to be used to load requests.  Beware  that
       by  using  a  configuration  file  libmemcached will reset memcached_st
       based on	information only contained in the file.

       --CONNECT-TIMEOUT=

       Please see MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT.

       --DISTRIBUTION=

       Set the distribution model used by the  client.	 See  :manpage:``  for
       more details.

       --HASH=

       Set the hashing alogrthm	used for placing keys on servers.

       --HASH-WITH-NAMESPACE

       When  enabled  the prefix key will be added to the key when determining
       which server to store the data in.

       --NOREPLY

       Enable "no reply" for all calls that support this. It is	highly	recom-
       mended that you use this	option with the	binary protocol	only.

       --NUMBER-OF-REPLICAS=

       Set the nummber of servers that keys will be replicated to.

       --RANDOMIZE-REPLICA-READ

       Select randomly the server within the replication pool to read from.

       --SORT-HOSTS

       When  adding  new  servers always calculate their distribution based on
       sorted naming order.

       --SUPPORT-CAS

       See memcached_behavior_set(3) for MEMCACHED_BEHAVIOR_SUPPORT_CAS

       --USE-UDP

       See memcached_behavior_set(3) for MEMCACHED_BEHAVIOR_USE_UDP

       --NAMESPACE=

       A namespace is a	container that provides	context	for keys,  only	 other
       requests	 that  know the	namespace can access these values. This	is ac-
       complished by prepending	the namespace value to all keys.

   Mecached Pool Options:
       --POOL-MIN

       Initial size of pool.

       --POOL-MAX

       Maximize	size of	the pool.

   I/O Options:
       --TCP-NODELAY

       See memcached_behavior_set(3) for MEMCACHED_BEHAVIOR_TCP_NODELAY

       --TCP-KEEPALIVE

       See memcached_behavior_set(3) for MEMCACHED_BEHAVIOR_TCP_KEEPALIVE

       --RETRY-TIMEOUT=

       See memcached_behavior_set(3) for MEMCACHED_BEHAVIOR_RETRY_TIMEOUT

       --SERVER-FAILURE-LIMIT=

       See   memcached_behavior_set(3)	 for   MEMCACHED_BEHAVIOR_SERVER_FAIL-
       URE_LIMIT

       --SND-TIMEOUT=

       See memcached_behavior_set(3) for MEMCACHED_BEHAVIOR_SND_TIMEOUT

       --SOCKET-RECV-SIZE=

       See memcached_behavior_set(3) for MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE

       --SOCKET-SEND-SIZE=

       See memcached_behavior_set(3) for MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE

       --POLL-TIMEOUT=

       That sets the value of the timeout used by :manpage: poll().

       --IO-BYTES-WATERMARK=

       --IO-KEY-PREFETCH=

       --IO-MSG-WATERMARK=

       --TCP-KEEPIDLE

       --RCV-TIMEOUT=

   Other:
       INCLUDE

       Include a file in configuration.	Unlike --CONFIGURE-FILE= this will not
       reset memcached_st

       RESET

       Reset memcached_st and continue to process.

       END

       End configutation processing.

       ERROR

       End configutation processing and	throw an error.

RETURN
       memcached() returns a pointer to	the memcached_st that was created  (or
       initialized).  On an allocation failure,	it returns NULL.

EXAMPLE
	  const	char *config_string= "--SERVER=host10.example.com --SERVER=host11.example.com --SERVER=host10.example.com"
	  memcached_st *memc= memcached(config_string, strlen(config_string);
	  {
	   ...
	  }
	  memcached_free(memc);

HOME
       To find out more	information please check: http://libmemcached.org/

SEE ALSO
       memcached(1) libmemcached(3) memcached_strerror(3)

AUTHOR
       Brian Aker

COPYRIGHT
       2011-2013, Brian	Aker DataDifferential, http://datadifferential.com/

1.0.18			       February	09, 2014		  MEMCACHED(3)

NAME | SYNOPSIS | DESCRIPTION | RETURN | EXAMPLE | HOME | SEE ALSO | AUTHOR | COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=memcached&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help