Allow the user to specify sync mode on an instance

Change-Id: Ibe6bbcece6f8ebb67a6b38fb1bbc5fb9baafdf1e
Reviewed-on: http://review.couchbase.org/12560
Tested-by: Trond Norbye <trond.norbye@gmail.com>
Reviewed-by: Matt Ingenthron <matt@couchbase.com>

Makefile.am

@@ -31,6 +31,7 @@ bin_PROGRAMS = tools/cbc
 
 
 pkginclude_HEADERS = \
+                     include/libcouchbase/behavior.h \
                      include/libcouchbase/callbacks.h \
                      include/libcouchbase/configuration.h \
                      include/libcouchbase/couchbase.h \
@@ -44,6 +45,7 @@ pkginclude_HEADERS = \
 libcouchbase_la_SOURCES = \
                         src/arithmetic.c \
                         src/base64.c \
+                        src/behavior.c \
                         src/config_static.h \
                         src/cookie.c \
                         src/error.c \
@@ -62,6 +64,7 @@ libcouchbase_la_SOURCES = \
                         src/stats.c \
                         src/store.c \
                         src/strerror.c \
+                        src/synchandler.c \
                         src/tap.c \
                         src/timings.c \
                         src/touch.c \

NMakefile

@@ -32,6 +32,7 @@ DLLCOMPILE=$(cc) $(cdebug) $(cflags) $(cvarsdll) $(DBGFLG) $(INCPATH) -DLIBCOUCH
 
 LIBCOUCHBASE_OBJS=arithmetic.obj \
      base64.obj \
+     behavior.obj \
      cookie.obj \
      error.obj \
      event.obj \
@@ -49,6 +50,7 @@ LIBCOUCHBASE_OBJS=arithmetic.obj \
      server.obj \
      store.obj \
      strerror.obj \
+     synchandler.obj \
      tap.obj \
      timings.obj \
      touch.obj \
@@ -150,6 +152,9 @@ arithmetic.obj: src\arithmetic.c
 base64.obj: src\base64.c
 	$(DLLCOMPILE) src\base64.c
 
+behavior.obj: src\behavior.c
+	$(DLLCOMPILE) src\behavior.c
+
 cookie.obj: src\cookie.c
 	$(DLLCOMPILE) src\cookie.c
 
@@ -207,6 +212,9 @@ store.obj: src\store.c
 strerror.obj: src\strerror.c
 	$(DLLCOMPILE) src\strerror.c
 
+synchandler.obj: src\synchandler.c
+	$(DLLCOMPILE) src\synchandler.c
+
 tap.obj: src\tap.c
 	$(DLLCOMPILE) src\tap.c
 

include/libcouchbase/behavior.h

@@ -0,0 +1,40 @@
+/* -*- Mode: C; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *     Copyright 2012 Couchbase, Inc.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+#ifndef LIBCOUCHBASE_BEHAVIOR_H
+#define LIBCOUCHBASE_BEHAVIOR_H 1
+
+#ifndef LIBCOUCHBASE_COUCHBASE_H
+#error "Include libcouchbase/couchbase.h instead"
+#endif
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+    LIBCOUCHBASE_API
+    void libcouchbase_behavior_set_syncmode(libcouchbase_t instance,
+                                            libcouchbase_syncmode_t syncmode);
+
+    LIBCOUCHBASE_API
+    libcouchbase_syncmode_t libcouchbase_behavior_get_syncmode(libcouchbase_t instance);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif

include/libcouchbase/couchbase.h

@@ -30,6 +30,7 @@
 #include <libcouchbase/configuration.h>
 #include <libcouchbase/visibility.h>
 #include <libcouchbase/types.h>
+#include <libcouchbase/behavior.h>
 #include <libcouchbase/callbacks.h>
 #include <libcouchbase/tap_filter.h>
 #include <libcouchbase/timings.h>

include/libcouchbase/types.h

@@ -257,6 +257,11 @@ extern "C" {
 
     } libcouchbase_io_opt_t;
 
+    typedef enum {
+        LIBCOUCHBASE_ASYNCHRONOUS = 0x00,
+        LIBCOUCHBASE_SYNCHRONOUS = 0xff
+    } libcouchbase_syncmode_t;
+
 #ifdef __cplusplus
 }
 #endif

src/arithmetic.c

@@ -48,7 +48,7 @@ libcouchbase_error_t libcouchbase_arithmetic_by_key(libcouchbase_t instance,
 
     /* we need a vbucket config before we can start getting data.. */
     if (instance->vbucket_config == NULL) {
-        return LIBCOUCHBASE_ETMPFAIL;
+        return libcouchbase_synchandler_return(instance, LIBCOUCHBASE_ETMPFAIL);
     }
 
     if (nhashkey == 0) {
@@ -86,5 +86,5 @@ libcouchbase_error_t libcouchbase_arithmetic_by_key(libcouchbase_t instance,
     libcouchbase_server_end_packet(server);
     libcouchbase_server_send_packets(server);
 
-    return LIBCOUCHBASE_SUCCESS;
+    return libcouchbase_synchandler_return(instance, LIBCOUCHBASE_SUCCESS);
 }

src/behavior.c

@@ -0,0 +1,29 @@
+/* -*- Mode: C; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *     Copyright 2012 Couchbase, Inc.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+#include "internal.h"
+
+LIBCOUCHBASE_API
+void libcouchbase_behavior_set_syncmode(libcouchbase_t instance, libcouchbase_syncmode_t syncmode)
+{
+    instance->syncmode = syncmode;
+}
+
+LIBCOUCHBASE_API
+libcouchbase_syncmode_t libcouchbase_behavior_get_syncmode(libcouchbase_t instance)
+{
+    return instance->syncmode;
+}

src/flush.c

@@ -27,7 +27,7 @@ libcouchbase_error_t libcouchbase_flush(libcouchbase_t instance,
 
     /* we need a vbucket config before we can start getting data.. */
     if (instance->vbucket_config == NULL) {
-        return LIBCOUCHBASE_ETMPFAIL;
+        return libcouchbase_synchandler_return(instance, LIBCOUCHBASE_ETMPFAIL);
     }
 
     memset(&flush, 0, sizeof(flush));
@@ -44,5 +44,5 @@ libcouchbase_error_t libcouchbase_flush(libcouchbase_t instance,
         libcouchbase_server_send_packets(server);
     }
 
-    return LIBCOUCHBASE_SUCCESS;
+    return libcouchbase_synchandler_return(instance, LIBCOUCHBASE_SUCCESS);
 }

src/get.c

@@ -62,7 +62,7 @@ libcouchbase_error_t libcouchbase_mget_by_key(libcouchbase_t instance,
 
     /* we need a vbucket config before we can start getting data.. */
     if (instance->vbucket_config == NULL) {
-        return LIBCOUCHBASE_ETMPFAIL;
+        return libcouchbase_synchandler_return(instance, LIBCOUCHBASE_ETMPFAIL);
     }
 
     if (num_keys == 1) {
@@ -133,7 +133,7 @@ libcouchbase_error_t libcouchbase_mget_by_key(libcouchbase_t instance,
         libcouchbase_server_send_packets(server);
     }
 
-    return LIBCOUCHBASE_SUCCESS;
+    return libcouchbase_synchandler_return(instance, LIBCOUCHBASE_SUCCESS);
 }
 
 static libcouchbase_error_t libcouchbase_single_get(libcouchbase_t instance,
@@ -179,5 +179,5 @@ static libcouchbase_error_t libcouchbase_single_get(libcouchbase_t instance,
     libcouchbase_server_end_packet(server);
     libcouchbase_server_send_packets(server);
 
-    return LIBCOUCHBASE_SUCCESS;
+    return libcouchbase_synchandler_return(instance, LIBCOUCHBASE_SUCCESS);
 }

src/instance.c

@@ -80,6 +80,7 @@ libcouchbase_t libcouchbase_create(const char *host,
         return NULL;
     }
     libcouchbase_initialize_packet_handlers(ret);
+    libcouchbase_behavior_set_syncmode(ret, LIBCOUCHBASE_ASYNCHRONOUS);
 
     ret->host = strdup(host);
     if ((p = strchr(ret->host, ':')) == NULL) {

src/internal.h

@@ -121,6 +121,9 @@ extern "C" {
 
         struct libcouchbase_io_opt_st *io;
 
+        /* The current synchronous mode */
+        libcouchbase_syncmode_t syncmode;
+
         evutil_socket_t sock;
         struct addrinfo *ai;
         struct addrinfo *curr_ai;
@@ -210,6 +213,8 @@ extern "C" {
         libcouchbase_t instance;
     };
 
+    libcouchbase_error_t libcouchbase_synchandler_return(libcouchbase_t instance, libcouchbase_error_t retcode);
+
     libcouchbase_error_t libcouchbase_error_handler(libcouchbase_t instance,
                                                     libcouchbase_error_t error,
                                                     const char *errinfo);

src/remove.c

@@ -47,7 +47,7 @@ libcouchbase_error_t libcouchbase_remove_by_key(libcouchbase_t instance,
 
     /* we need a vbucket config before we can start removing the item.. */
     if (instance->vbucket_config == NULL) {
-        return LIBCOUCHBASE_ETMPFAIL;
+        return libcouchbase_synchandler_return(instance, LIBCOUCHBASE_ETMPFAIL);
     }
 
     if (nhashkey == 0) {
@@ -74,5 +74,5 @@ libcouchbase_error_t libcouchbase_remove_by_key(libcouchbase_t instance,
     libcouchbase_server_end_packet(server);
     libcouchbase_server_send_packets(server);
 
-    return LIBCOUCHBASE_SUCCESS;
+    return libcouchbase_synchandler_return(instance, LIBCOUCHBASE_SUCCESS);
 }

src/stats.c

@@ -34,7 +34,7 @@ libcouchbase_error_t libcouchbase_server_stats(libcouchbase_t instance,
 
     /* we need a vbucket config before we can start getting data.. */
     if (instance->vbucket_config == NULL) {
-        return LIBCOUCHBASE_ETMPFAIL;
+        return libcouchbase_synchandler_return(instance, LIBCOUCHBASE_ETMPFAIL);
     }
 
     memset(&req, 0, sizeof(req));
@@ -53,5 +53,5 @@ libcouchbase_error_t libcouchbase_server_stats(libcouchbase_t instance,
         libcouchbase_server_end_packet(server);
         libcouchbase_server_send_packets(server);
     }
-    return LIBCOUCHBASE_SUCCESS;
+    return libcouchbase_synchandler_return(instance, LIBCOUCHBASE_SUCCESS);
 }

src/store.c

@@ -56,7 +56,7 @@ libcouchbase_error_t libcouchbase_store_by_key(libcouchbase_t instance,
 
     /* we need a vbucket config before we can start getting data.. */
     if (instance->vbucket_config == NULL) {
-        return LIBCOUCHBASE_ETMPFAIL;
+        return libcouchbase_synchandler_return(instance, LIBCOUCHBASE_ETMPFAIL);
     }
 
     if (nhashkey == 0) {
@@ -100,8 +100,9 @@ libcouchbase_error_t libcouchbase_store_by_key(libcouchbase_t instance,
         break;
     default:
         /* We were given an unknown storage operation. */
-        return libcouchbase_error_handler(instance, LIBCOUCHBASE_EINVAL,
-                                          "Invalid value passed as storage operation");
+        return libcouchbase_synchandler_return(instance,
+                                               libcouchbase_error_handler(instance, LIBCOUCHBASE_EINVAL,
+                                                                          "Invalid value passed as storage operation"));
     }
 
     /* Make it known that this was a success. */
@@ -116,5 +117,5 @@ libcouchbase_error_t libcouchbase_store_by_key(libcouchbase_t instance,
     libcouchbase_server_end_packet(server);
     libcouchbase_server_send_packets(server);
 
-    return LIBCOUCHBASE_SUCCESS;
+    return libcouchbase_synchandler_return(instance, LIBCOUCHBASE_SUCCESS);
 }

src/synchandler.c

@@ -0,0 +1,75 @@
+/* -*- Mode: C; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *     Copyright 2012 Couchbase, Inc.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+#include "internal.h"
+
+struct user_cookie {
+    void *cookie;
+    libcouchbase_error_callback error;
+    libcouchbase_error_t retcode;
+};
+
+
+static void error_callback(libcouchbase_t instance,
+                           libcouchbase_error_t error,
+                           const char *errinfo)
+{
+    struct user_cookie *cookie = (void*)instance->cookie;
+    if (error == LIBCOUCHBASE_SUCCESS) {
+        return ;
+    }
+
+    /* Restore the users environment */
+    instance->cookie = cookie->cookie;
+    instance->callbacks.error = cookie->error;
+
+    /* Call the user's callback */
+    cookie->error(instance, error, errinfo);
+
+    /* Restore the wrapping environment */
+    cookie->error = instance->callbacks.error; /* User might have changed this */
+    instance->cookie = cookie;
+
+    /* Save the error code */
+    cookie->retcode = error;
+
+    /* Ok, stop the event loop */
+    instance->io->stop_event_loop(instance->io);
+}
+
+libcouchbase_error_t libcouchbase_synchandler_return(libcouchbase_t instance, libcouchbase_error_t retcode)
+{
+    struct user_cookie cookie;
+
+    if (instance->syncmode == LIBCOUCHBASE_ASYNCHRONOUS ||
+        retcode != LIBCOUCHBASE_SUCCESS) {
+        return retcode;
+    }
+
+    cookie.retcode = LIBCOUCHBASE_SUCCESS;
+
+    /* Save the users environment */
+    cookie.error = instance->callbacks.error;
+    cookie.cookie = (void*)instance->cookie;
+    instance->cookie = &cookie;
+
+    libcouchbase_wait(instance);
+    /* Restore the environment */
+    instance->callbacks.error = cookie.error;
+    instance->cookie = cookie.cookie;
+
+    return cookie.retcode;
+}

src/touch.c

@@ -53,7 +53,7 @@ libcouchbase_error_t libcouchbase_mtouch_by_key(libcouchbase_t instance,
 
     /* we need a vbucket config before we can start getting data.. */
     if (instance->vbucket_config == NULL) {
-        return LIBCOUCHBASE_ETMPFAIL;
+        return libcouchbase_synchandler_return(instance, LIBCOUCHBASE_ETMPFAIL);
     }
 
     if (nhashkey != 0) {
@@ -87,5 +87,5 @@ libcouchbase_error_t libcouchbase_mtouch_by_key(libcouchbase_t instance,
 
     libcouchbase_server_send_packets(server);
 
-    return LIBCOUCHBASE_SUCCESS;
+    return libcouchbase_synchandler_return(instance, LIBCOUCHBASE_SUCCESS);
 }