Couchbase C Client  2.9.4
Asynchronous C Client for Couchbase
deprecated.h File Reference

Deprecated APIs. More...

Go to the source code of this file.

Macros

#define LCB_DEPR_API(X)
 
#define LCB_DEPR_API2(X, reason)
 
#define lcb_create_compat
 
#define LCB_XSSIZES(X)
 
#define X(sname, sabbrev, idval, vernum)
 
#define lcb_verify_compiler_setup()
 
#define LCB_CNTL_RBUFSIZE
 Deprecated cntls. More...
 
#define LCB_CNTL_WBUFSIZE
 
#define LCB_CNTL_SYNCMODE
 
#define LCB_CNTL_SKIP_CONFIGURATION_ERRORS_ON_CONNECT
 
#define lcb_is_error_enomem(a)
 
#define lcb_is_error_etmpfail(a)
 

Typedefs

typedef void(* lcb_error_callback) (lcb_t instance, lcb_error_t error, const char *errinfo)
 
typedef struct lcb_timer_st * lcb_timer_t
 
typedef void(* lcb_timer_callback) (lcb_timer_t timer, lcb_t instance, const void *cookie)
 
typedef lcb_compat_t lcb_cluster_t
 
typedef void(* lcb_configuration_callback) (lcb_t instance, lcb_configuration_t config)
 

Enumerations

enum  lcb_vbucket_state_t
 I'm not sure what uses this anymore.
 
enum  lcb_compat_t
 
enum  lcb_syncmode_t
 
enum  lcb__STRUCTSIZES
 
enum  lcb_configuration_t
 
enum  lcb_http_status_t
 
enum  lcbcrypto_KEYTYPE
 

Functions

 LCB_DEPR_API2 (void lcb_behavior_set_ipv6(lcb_t instance, lcb_ipv6_t mode), "Use LCB_CNTL_IP6POLICY")
 
 LCB_DEPR_API2 (lcb_ipv6_t lcb_behavior_get_ipv6(lcb_t instance), "Use LCB_CNTL_IP6POLICY")
 
 LCB_DEPR_API2 (void lcb_behavior_set_config_errors_threshold(lcb_t instance, lcb_size_t num_events), "Use LCB_CNTL_CONFERRTHRESH")
 
 LCB_DEPR_API2 (lcb_size_t lcb_behavior_get_config_errors_threshold(lcb_t instance), "Use LCB_CNTL_CONFERRTHRESH")
 
 LCB_DEPR_API2 (void lcb_set_timeout(lcb_t instance, lcb_uint32_t usec), "Use LCB_CNTL_OP_TIMEOUT")
 
 LCB_DEPR_API2 (lcb_uint32_t lcb_get_timeout(lcb_t instance), "Use LCB_CNTL_OP_TIMEOUT")
 
 LCB_DEPR_API2 (void lcb_set_view_timeout(lcb_t instance, lcb_uint32_t usec), "Use LCB_CNTL_VIEW_TIMEOUT")
 
 LCB_DEPR_API2 (lcb_uint32_t lcb_get_view_timeout(lcb_t instance), "Use LCB_CNTL_VIEW_TIMEOUT")
 
 LCB_DEPR_API2 (lcb_error_t lcb_get_last_error(lcb_t instance), "This function does not returning meaningful information. Use the operation callbacks " "and/or bootstrap callbacks")
 
 LCB_DEPR_API2 (void lcb_flush_buffers(lcb_t instance, const void *cookie), "This function does nothing")
 
 LCB_DEPR_API2 (lcb_error_callback lcb_set_error_callback(lcb_t, lcb_error_callback), "This function only reports bootstrap errors. Use lcb_set_bootstrap_callback instead")
 
lcb_timer_t lcb_timer_create (lcb_t instance, const void *command_cookie, lcb_uint32_t usec, int periodic, lcb_timer_callback callback, lcb_error_t *error))
 
lcb_error_t lcb_timer_destroy (lcb_t instance, lcb_timer_t timer))
 
 LCB_DEPR_API2 (lcb_error_t lcb_create_compat(lcb_compat_t type, const void *specific, lcb_t *instance, struct lcb_io_opt_st *io), "Use memcached:// for legacy memcached. For config cache, use LCB_CNTL_CONFIGCACHE")
 
 LCB_DEPR_API2 (void lcb_behavior_set_syncmode(lcb_t, lcb_syncmode_t), "Syncmode will be removed in future versions. Use lcb_wait() instead")
 
 LCB_DEPR_API2 (lcb_syncmode_t lcb_behavior_get_syncmode(lcb_t), "Syncmode will be removed in future versions. Use lcb_wait() instead")
 
 LCB_DEPR_API2 (const char *lcb_get_host(lcb_t), "Use lcb_get_node(instance, LCB_NODE_HTCONFIG, 0)")
 
lcb_error_t lcb_verify_struct_size (lcb_uint32_t id, lcb_uint32_t version, lcb_size_t size)
 Verify that libcouchbase and yourself have the same size for a certain version of a struct. More...
 
 LCB_DEPR_API2 (lcb_configuration_callback lcb_set_configuration_callback(lcb_t, lcb_configuration_callback), "use lcb_set_bootstrap_callback() to determine when client is ready")
 

Detailed Description

Deprecated APIs.

Macro Definition Documentation

◆ lcb_create_compat

#define lcb_create_compat
Deprecated:
Use LCB_CNTL_CONFIGCACHE for configuration cache options

◆ LCB_CNTL_RBUFSIZE

#define LCB_CNTL_RBUFSIZE

Deprecated cntls.

Deprecated:
It is currently not possible to adjust buffer sizes

◆ LCB_CNTL_WBUFSIZE

#define LCB_CNTL_WBUFSIZE
Deprecated:
It is currently not possible to adjust buffer sizes

◆ LCB_CNTL_SYNCMODE

#define LCB_CNTL_SYNCMODE

◆ LCB_CNTL_SKIP_CONFIGURATION_ERRORS_ON_CONNECT

#define LCB_CNTL_SKIP_CONFIGURATION_ERRORS_ON_CONNECT
Deprecated:
Initial connections are always attempted

◆ lcb_is_error_enomem

#define lcb_is_error_enomem (   a)
Deprecated:
Use error classifiers

◆ lcb_is_error_etmpfail

#define lcb_is_error_etmpfail (   a)
Deprecated:
Use error classifiers

Enumeration Type Documentation

◆ lcbcrypto_KEYTYPE

Function Documentation

◆ LCB_DEPR_API2() [1/12]

LCB_DEPR_API2 ( void   lcb_behavior_set_ipv6lcb_t instance, lcb_ipv6_t mode,
"Use LCB_CNTL_IP6POLICY  
)

◆ LCB_DEPR_API2() [2/12]

LCB_DEPR_API2 ( lcb_ipv6_t   lcb_behavior_get_ipv6lcb_t instance,
"Use LCB_CNTL_IP6POLICY  
)

◆ LCB_DEPR_API2() [3/12]

LCB_DEPR_API2 ( void   lcb_behavior_set_config_errors_thresholdlcb_t instance, lcb_size_t num_events,
"Use LCB_CNTL_CONFERRTHRESH  
)

◆ LCB_DEPR_API2() [4/12]

LCB_DEPR_API2 ( lcb_size_t   lcb_behavior_get_config_errors_thresholdlcb_t instance,
"Use LCB_CNTL_CONFERRTHRESH  
)

◆ LCB_DEPR_API2() [5/12]

LCB_DEPR_API2 ( void   lcb_set_timeoutlcb_t instance, lcb_uint32_t usec,
"Use LCB_CNTL_OP_TIMEOUT  
)

◆ LCB_DEPR_API2() [6/12]

LCB_DEPR_API2 ( lcb_uint32_t   lcb_get_timeoutlcb_t instance,
"Use LCB_CNTL_OP_TIMEOUT  
)

◆ LCB_DEPR_API2() [7/12]

LCB_DEPR_API2 ( void   lcb_set_view_timeoutlcb_t instance, lcb_uint32_t usec,
"Use LCB_CNTL_VIEW_TIMEOUT  
)

◆ LCB_DEPR_API2() [8/12]

LCB_DEPR_API2 ( lcb_uint32_t   lcb_get_view_timeoutlcb_t instance,
"Use LCB_CNTL_VIEW_TIMEOUT  
)

◆ LCB_DEPR_API2() [9/12]

LCB_DEPR_API2 ( lcb_error_t   lcb_get_last_errorlcb_t instance,
"This function does not returning meaningful information. Use the operation callbacks " "and/or bootstrap callbacks"   
)
Deprecated:
Do not use this function.

Check the error code of the specific operation to determine if something succeeded or not. Because the library has many asynchronous "flows" of control, determining the "last error" is not very fruitful. Since most API calls are themselves only schedule-related, they cannot possibly derive a "Real" error either

◆ LCB_DEPR_API2() [10/12]

LCB_DEPR_API2 ( void   lcb_flush_bufferslcb_t instance, const void *cookie,
"This function does nothing"   
)
Deprecated:
This function does nothing

◆ LCB_DEPR_API2() [11/12]

LCB_DEPR_API2 ( lcb_error_callback   lcb_set_error_callbacklcb_t, lcb_error_callback,
"This function only reports bootstrap errors. Use lcb_set_bootstrap_callback instead"   
)
Deprecated:
Use the logging API (LCB_CNTL_LOGGER) instead to receive error information.

For programmatic errors, use the operations interface. For bootstrap status, use lcb_get_bootstrap_status() and lcb_set_bootstrap_callback()

◆ lcb_timer_create()

lcb_timer_t lcb_timer_create ( lcb_t  instance,
const void *  command_cookie,
lcb_uint32_t  usec,
int  periodic,
lcb_timer_callback  callback,
lcb_error_t error 
)

◆ lcb_timer_destroy()

lcb_error_t lcb_timer_destroy ( lcb_t  instance,
lcb_timer_t  timer 
)

◆ lcb_verify_struct_size()

lcb_error_t lcb_verify_struct_size ( lcb_uint32_t  id,
lcb_uint32_t  version,
lcb_size_t  size 
)

Verify that libcouchbase and yourself have the same size for a certain version of a struct.

Using different alignment / struct packing will give you strange results..

Parameters
idthe id of the structure to check
versionthe version of the structure to check
sizethe expected size of the structure
Returns
LCB_SUCCESS on success

◆ LCB_DEPR_API2() [12/12]

LCB_DEPR_API2 ( lcb_configuration_callback   lcb_set_configuration_callbacklcb_t, lcb_configuration_callback,
"use lcb_set_bootstrap_callback() to determine when client is ready"   
)