PROTON-1442: [Cpp] Support for local transactions

cpp/examples/CMakeLists.txt

@@ -60,7 +60,9 @@ foreach(example
     scheduled_send
     service_bus
     multithreaded_client
-    multithreaded_client_flow_control)
+    multithreaded_client_flow_control
+    tx_send
+    tx_recv)
   add_executable(${example} ${example}.cpp)
   target_link_libraries(${example} Proton::cpp Threads::Threads)
 endforeach()

cpp/examples/simple_recv.cpp

@@ -43,10 +43,11 @@ class simple_recv : public proton::messaging_handler {
     proton::receiver receiver;
     int expected;
     int received;
+    bool verbose;
 
   public:
-    simple_recv(const std::string &s, const std::string &u, const std::string &p, int c) :
-        url(s), user(u), password(p), expected(c), received(0) {}
+    simple_recv(const std::string &s, const std::string &u, const std::string &p, int c, bool verbose) :
+        url(s), user(u), password(p), expected(c), received(0), verbose(verbose) {}
 
     void on_container_start(proton::container &c) override {
         proton::connection_options co;
@@ -61,6 +62,9 @@ class simple_recv : public proton::messaging_handler {
         }
 
         if (expected == 0 || received < expected) {
+            if (verbose) {
+                std::cout << msg << ": ";
+            }
             std::cout << msg.body() << std::endl;
             received++;
 
@@ -77,18 +81,20 @@ int main(int argc, char **argv) {
     std::string user;
     std::string password;
     int message_count = 100;
+    bool verbose;
     example::options opts(argc, argv);
 
     opts.add_value(address, 'a', "address", "connect to and receive from URL", "URL");
     opts.add_value(message_count, 'm', "messages", "receive COUNT messages", "COUNT");
     opts.add_value(user, 'u', "user", "authenticate as USER", "USER");
     opts.add_value(password, 'p', "password", "authenticate with PASSWORD", "PASSWORD");
+    opts.add_flag(verbose, 'v', "verbose", "show whole message contents");
 
 
     try {
         opts.parse();
 
-        simple_recv recv(address, user, password, message_count);
+        simple_recv recv(address, user, password, message_count, verbose);
         proton::container(recv).run();
 
         return 0;

cpp/examples/tx_recv.cpp

@@ -0,0 +1,151 @@
+/*
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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 "options.hpp"
+
+#include <proton/connection.hpp>
+#include <proton/container.hpp>
+#include <proton/delivery.hpp>
+#include <proton/message_id.hpp>
+#include <proton/message.hpp>
+#include <proton/messaging_handler.hpp>
+#include <proton/receiver_options.hpp>
+#include <proton/source.hpp>
+#include <proton/types.hpp>
+
+#include <iostream>
+#include <map>
+#include <string>
+
+#include <atomic>
+#include <chrono>
+#include <thread>
+
+class tx_recv : public proton::messaging_handler {
+  private:
+    proton::receiver receiver;
+    proton::session session;
+    std::string conn_url_;
+    std::string addr_;
+    int total;
+    int batch_size;
+    int received = 0;
+    int current_batch = 0;
+    int batch_index = 0;
+
+  public:
+    tx_recv(const std::string& u, const std::string &a, int c, int b):
+        conn_url_(u), addr_(a), total(c), batch_size(b) {}
+
+    void on_container_start(proton::container &c) override {
+        c.connect(conn_url_);
+    }
+
+   void on_connection_open(proton::connection& c) override {
+        // NOTE:credit_window(0) disables automatic flow control.
+        // We will use flow control to receive batches of messages in a transaction.
+        std::cout << "In this example we abort/commit transaction alternatively." << std::endl;
+        receiver = c.open_receiver(addr_, proton::receiver_options().credit_window(0));
+    }
+
+    void on_session_open(proton::session &s) override {
+        if(!s.transaction_is_declared()) {
+            std::cout << "New session is open" << std::endl;
+            s.transaction_declare(*this);
+            session = s;
+        } else {
+            std::cout << "Transaction is declared: " << s.transaction_id() << std::endl;
+            receiver.add_credit(batch_size);
+        }
+    }
+
+    void on_session_error(proton::session &s) override {
+        std::cout << "Session error: " << s.error().what() << std::endl;
+        s.connection().close();
+        exit(-1);
+    }
+
+    void on_session_transaction_committed(proton::session &s) override {
+        std::cout << "Transaction commited" << std::endl;
+        received += current_batch;
+        current_batch = 0;
+        if (received == total) {
+            std::cout << "All received messages committed, closing connection." << std::endl;
+            s.connection().close();
+        }
+        else {
+            std::cout << "Re-declaring transaction now... to receive next batch." << std::endl;
+            s.transaction_declare(*this);
+        }
+    }
+
+    void on_session_transaction_aborted(proton::session &s) override {
+        std::cout << "Transaction aborted!" << std::endl;
+        std::cout << "Re-delaring transaction now..." << std::endl;
+        current_batch = 0;
+        s.transaction_declare(*this);
+    }
+
+    void on_message(proton::delivery &d, proton::message &msg) override {
+        std::cout<<"# MESSAGE: " << msg.id() <<": "  << msg.body() << std::endl;
+        d.accept();
+        current_batch += 1;
+        if (current_batch == batch_size) {
+            // Batch complete
+            if (batch_index % 2 == 1) {
+                std::cout << "Commiting transaction..." << std::endl;
+                session.transaction_commit();
+            } else {
+                std::cout << "Aborting transaction..." << std::endl;
+                session.transaction_abort();
+            }
+            batch_index++;
+        }
+    }
+};
+
+int main(int argc, char **argv) {
+    std::string conn_url = argc > 1 ? argv[1] : "//127.0.0.1:5672";
+    std::string addr = argc > 2 ? argv[2] : "examples";
+    int message_count = 6;
+    int batch_size = 3;
+    example::options opts(argc, argv);
+
+    opts.add_value(conn_url, 'u', "url", "connect and send to URL", "URL");
+    opts.add_value(addr, 'a', "address", "connect and send to address", "URL");
+    opts.add_value(message_count, 'm', "messages", "number of messages to send", "COUNT");
+    opts.add_value(batch_size, 'b', "batch_size", "number of messages in each transaction", "BATCH_SIZE");
+
+    try {
+        opts.parse();
+
+        tx_recv recv(conn_url, addr, message_count, batch_size);
+        proton::container(recv).run();
+
+        return 0;
+    } catch (const example::bad_option& e) {
+        std::cout << opts << std::endl << e.what() << std::endl;
+    } catch (const std::exception& e) {
+        std::cerr << e.what() << std::endl;
+    }
+
+    return 1;
+}

cpp/examples/tx_send.cpp

@@ -0,0 +1,172 @@
+/*
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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 "options.hpp"
+
+#include <proton/connection.hpp>
+#include <proton/container.hpp>
+#include <proton/message.hpp>
+#include <proton/message_id.hpp>
+#include <proton/messaging_handler.hpp>
+#include <proton/sender_options.hpp>
+#include <proton/types.hpp>
+
+#include <iostream>
+#include <map>
+#include <string>
+
+#include <atomic>
+#include <chrono>
+#include <thread>
+
+class tx_send : public proton::messaging_handler {
+  private:
+    proton::sender sender;
+    std::string conn_url_;
+    std::string addr_;
+    int total;
+    int batch_size;
+    int sent;
+    int batch_index = 0;
+    int current_batch = 0;
+    int committed = 0;
+    std::atomic<int> unique_msg_id;
+
+  public:
+    tx_send(const std::string& u, const std::string& a, int c, int b):
+        conn_url_(u), addr_(a), total(c), batch_size(b), sent(0), unique_msg_id(10000) {}
+
+    void on_container_start(proton::container &c) override {
+        c.connect(conn_url_);
+    }
+
+    void on_connection_open(proton::connection& c) override {
+        std::cout << "In this example we abort/commit transaction alternatively." << std::endl;
+        sender = c.open_sender(addr_);
+    }
+
+    void on_session_open(proton::session& s) override {
+        if(!s.transaction_is_declared()) {
+            std::cout << "New session is open, declaring transaction now..." << std::endl;
+            s.transaction_declare(*this);
+        } else {
+            std::cout << "Transaction is declared: " << s.transaction_id() << std::endl;
+            send();
+        }
+    }
+
+    void on_session_error(proton::session &s) override {
+        std::cout << "Session error: " << s.error().what() << std::endl;
+        s.connection().close();
+        exit(-1);
+    }
+
+    void on_session_transaction_commit_failed(proton::session &s) override {
+        std::cout << "Transaction commit failed!" << std::endl;
+        s.connection().close();
+        exit(-1);
+    }
+
+    void on_sendable(proton::sender&) override {
+        send();
+    }
+
+    void send() {
+        proton::session session = sender.session();
+        while (session.transaction_is_declared() && sender.credit() &&
+               (committed + current_batch) < total) {
+            proton::message msg;
+            std::map<std::string, int> m;
+            m["sequence"] = committed + current_batch;
+
+            msg.id(std::atomic_fetch_add(&unique_msg_id, 1));
+            msg.body(m);
+            std::cout << "Sending [sender batch " << batch_index << "]: " << msg << std::endl;
+            sender.send(msg);
+            current_batch += 1;
+            if(current_batch == batch_size)
+            {
+                if (batch_index % 2 == 0) {
+                    std::cout << "Commiting transaction..." << std::endl;
+                    session.transaction_commit();
+                } else {
+                    std::cout << "Aborting transaction..." << std::endl;
+                    session.transaction_abort();
+                }
+                batch_index++;
+            }
+        }
+    }
+
+    void on_session_transaction_committed(proton::session &s) override {
+        committed += current_batch;
+        current_batch = 0;
+        std::cout << "Transaction commited" << std::endl;
+        if(committed == total) {
+            std::cout << "All messages committed, closing connection." << std::endl;
+            s.connection().close();
+        }
+        else {
+            std::cout << "Re-declaring transaction now..." << std::endl;
+            s.transaction_declare(*this);
+        }
+    }
+
+    void on_session_transaction_aborted(proton::session &s) override {
+        std::cout << "Transaction aborted!" << std::endl;
+        std::cout << "Re-delaring transaction now..." << std::endl;
+        current_batch = 0;
+        s.transaction_declare(*this);
+    }
+
+    void on_sender_close(proton::sender &s) override {
+        current_batch = 0;
+    }
+
+};
+
+int main(int argc, char **argv) {
+    std::string conn_url = argc > 1 ? argv[1] : "//127.0.0.1:5672";
+    std::string addr = argc > 2 ? argv[2] : "examples";
+    int message_count = 6;
+    int batch_size = 3;
+    example::options opts(argc, argv);
+
+    opts.add_value(conn_url, 'u', "url", "connect and send to URL", "URL");
+    opts.add_value(addr, 'a', "address", "connect and send to address", "URL");
+    opts.add_value(message_count, 'm', "messages", "number of messages to send", "COUNT");
+    opts.add_value(batch_size, 'b', "batch_size", "number of messages in each transaction", "BATCH_SIZE");
+
+    try {
+        opts.parse();
+
+        tx_send send(conn_url, addr, message_count, batch_size);
+        proton::container(send).run();
+
+        return 0;
+    } catch (const example::bad_option& e) {
+        std::cout << opts << std::endl << e.what() << std::endl;
+    } catch (const std::exception& e) {
+        std::cerr << e.what() << std::endl;
+    }
+
+    return 1;
+}

cpp/include/proton/messaging_handler.hpp

@@ -172,6 +172,15 @@ PN_CPP_CLASS_EXTERN messaging_handler {
     /// The remote peer closed the session with an error condition.
     PN_CPP_EXTERN virtual void on_session_error(session&);
 
+    /// Called when a local transaction is discharged successfully.
+    PN_CPP_EXTERN virtual void on_session_transaction_committed(session&);
+
+    /// Called when the commit of a local transaction fails.
+    PN_CPP_EXTERN virtual void on_session_transaction_commit_failed(session&);
+
+    /// Called when a local transaction is discharged unsuccessfully (aborted).
+    PN_CPP_EXTERN virtual void on_session_transaction_aborted(session&);
+
     /// The remote peer opened the link.
     PN_CPP_EXTERN virtual void on_receiver_open(receiver&);