Merging bzr://gaz.tangent.org/libmemcached/build/ to Build branch
[m6w6/libmemcached] / docs / man / memcached_return_t.3
index 43f39eece8ab8607d19d1a69b2f7d28e60dec1d9..b571833471ea0cfd270c073d17d00a9250f7775e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "MEMCACHED_RETURN_T" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_RETURN_T" "3" "April 13, 2012" "1.0.6" "libmemcached"
 .SH NAME
 memcached_return_t \- Return type values 
 .
@@ -39,223 +39,128 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .UNINDENT
 .INDENT 0.0
 .TP
-.B const char *libmemcached_strerror(libmemcached_return_t\fI\ rc\fP)
+.B const char *libmemcached_strerror(\fI\%memcached_return_t\fP\fI\ rc\fP)
 .UNINDENT
 .INDENT 0.0
 .TP
-.B bool libmemcached_success(libmemcached_return_t\fI\ rc\fP)
+.B bool libmemcached_success(\fI\%memcached_return_t\fP\fI\ rc\fP)
 .UNINDENT
 .INDENT 0.0
 .TP
-.B bool libmemcached_failure(libmemcached_return_t\fI\ rc\fP)
+.B bool libmemcached_failure(\fI\%memcached_return_t\fP\fI\ rc\fP)
 .UNINDENT
 .INDENT 0.0
 .TP
-.B bool libmemcache_continue(libmemcached_return_t\fI\ rc\fP)
-.UNINDENT
-.sp
-\fBmemcached_success()\fP return true if \fI\%MEMCACHED_SUCCESS\fP tested true.
-.sp
-\fBmemcached_failure()\fP return true if any value other then \fI\%MEMCACHED_SUCCESS\fP was provided.
-.SS Libmemcached return types:
-.INDENT 0.0
-.TP
-.B MEMCACHED_SUCCESS
-.UNINDENT
-.sp
-Success
-.INDENT 0.0
-.TP
-.B MEMCACHED_FAILURE
+.B bool libmemcache_continue(\fI\%memcached_return_t\fP\fI\ rc\fP)
 .UNINDENT
 .INDENT 0.0
 .TP
-.B MEMCACHED_HOST_LOOKUP_FAILURE
+.B bool memcached_success(\fI\%memcached_return_t\fP)
 .UNINDENT
 .INDENT 0.0
 .TP
-.B MEMCACHED_CONNECTION_FAILURE
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_CONNECTION_BIND_FAILURE
+.B bool memcached_failure(\fI\%memcached_return_t\fP)
 .UNINDENT
 .sp
-Deprecated since version <0.30.
-.INDENT 0.0
-.TP
-.B MEMCACHED_WRITE_FAILURE
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_READ_FAILURE
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_UNKNOWN_READ_FAILURE
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_PROTOCOL_ERROR
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_CLIENT_ERROR
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_SERVER_ERROR
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
-.UNINDENT
+\fI\%memcached_success()\fP return true if \fBMEMCACHED_SUCCESS\fP tested true.
 .sp
-Deprecated since version <0.30.
-.INDENT 0.0
-.TP
-.B MEMCACHED_DATA_EXISTS
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_DATA_DOES_NOT_EXIST
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_NOTSTORED
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_STORED
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_NOTFOUND
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_MEMORY_ALLOCATION_FAILURE
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_PARTIAL_READ
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_SOME_ERRORS
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_NO_SERVERS
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_END
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_DELETED
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_VALUE
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_STAT
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_ITEM
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_ERRNO
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_FAIL_UNIX_SOCKET
-.UNINDENT
+\fI\%memcached_failure()\fP return true if any value other then \fBMEMCACHED_SUCCESS\fP was provided.
+.SS Libmemcached return types:
 .sp
-Deprecated since version <0.30.
-.INDENT 0.0
-.TP
-.B MEMCACHED_NOT_SUPPORTED
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_NO_KEY_PROVIDED
-.UNINDENT
+\fBMEMCACHED_SUCCESS\fP
 .sp
-Deprecated since version <0.30: Use \fI\%MEMCACHED_BAD_KEY_PROVIDED\fP instead.
-.INDENT 0.0
-.TP
-.B MEMCACHED_FETCH_NOTFINISHED
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_TIMEOUT
-Connection to server timed out.
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_BUFFERED
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_BAD_KEY_PROVIDED
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_INVALID_HOST_PROTOCOL
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_SERVER_MARKED_DEAD
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_UNKNOWN_STAT_KEY
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_E2BIG
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_INVALID_ARGUMENTS
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_KEY_TOO_BIG
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_AUTH_PROBLEM
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_AUTH_FAILURE
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_AUTH_CONTINUE
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_PARSE_ERROR
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_PARSE_USER_ERROR
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_DEPRECATED
-.UNINDENT
+\fBMEMCACHED_FAILURE\fP
+.sp
+\fBMEMCACHED_HOST_LOOKUP_FAILURE\fP
+.sp
+\fBMEMCACHED_CONNECTION_FAILURE\fP
+.sp
+\fBMEMCACHED_CONNECTION_BIND_FAILURE\fP
+.sp
+\fBMEMCACHED_WRITE_FAILURE\fP
+.sp
+\fBMEMCACHED_READ_FAILURE\fP
+.sp
+\fBMEMCACHED_UNKNOWN_READ_FAILURE\fP
+.sp
+\fBMEMCACHED_PROTOCOL_ERROR\fP
+.sp
+\fBMEMCACHED_CLIENT_ERROR\fP
+.sp
+\fBMEMCACHED_SERVER_ERROR\fP
+.sp
+\fBMEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE\fP
+.sp
+\fBMEMCACHED_DATA_EXISTS\fP
+.sp
+\fBMEMCACHED_DATA_DOES_NOT_EXIST\fP
+.sp
+\fBMEMCACHED_NOTSTORED\fP
+.sp
+\fBMEMCACHED_STORED\fP
+.sp
+\fBMEMCACHED_NOTFOUND\fP
+.sp
+\fBMEMCACHED_MEMORY_ALLOCATION_FAILURE\fP
+.sp
+\fBMEMCACHED_PARTIAL_READ\fP
+.sp
+\fBMEMCACHED_SOME_ERRORS\fP
+.sp
+\fBMEMCACHED_NO_SERVERS\fP
+.sp
+\fBMEMCACHED_END\fP
+.sp
+\fBMEMCACHED_DELETED\fP
+.sp
+\fBMEMCACHED_VALUE\fP
+.sp
+\fBMEMCACHED_STAT\fP
+.sp
+\fBMEMCACHED_ITEM\fP
+.sp
+\fBMEMCACHED_ERRNO\fP
+.sp
+\fBMEMCACHED_FAIL_UNIX_SOCKET\fP
+.sp
+\fBMEMCACHED_NOT_SUPPORTED\fP
+.sp
+\fBMEMCACHED_NO_KEY_PROVIDED\fP
+.sp
+\fBMEMCACHED_FETCH_NOTFINISHED\fP
+.sp
+\fBMEMCACHED_TIMEOUT\fP
+.sp
+\fBMEMCACHED_BUFFERED\fP
+.sp
+\fBMEMCACHED_BAD_KEY_PROVIDED\fP
+.sp
+\fBMEMCACHED_INVALID_HOST_PROTOCOL\fP
+.sp
+\fBMEMCACHED_SERVER_MARKED_DEAD\fP
+.sp
+\fBMEMCACHED_UNKNOWN_STAT_KEY\fP
+.sp
+\fBMEMCACHED_E2BIG\fP
+.sp
+\fBMEMCACHED_INVALID_ARGUMENTS\fP
+.sp
+\fBMEMCACHED_KEY_TOO_BIG\fP
+.sp
+\fBMEMCACHED_AUTH_PROBLEM\fP
+.sp
+\fBMEMCACHED_AUTH_FAILURE\fP
+.sp
+\fBMEMCACHED_AUTH_CONTINUE\fP
+.sp
+\fBMEMCACHED_PARSE_ERROR\fP
+.sp
+\fBMEMCACHED_PARSE_USER_ERROR\fP
+.sp
+\fBMEMCACHED_DEPRECATED\fP
 .SH SEE ALSO
 .sp
-\fImemcached(8)\fP \fIlibmemcached(3)\fP \fImemcached_client_error()\fP or \fImemcached_worker_error()\fP
+\fImemcached\fP \fIlibmemcached\fP \fImemcached_client_error\fP or \fImemcached_worker_error\fP
 .SH AUTHOR
 Brian Aker
 .SH COPYRIGHT