www.it-ebooks.info ZeroMQ Use ZeroMQ and learn how to apply different message patterns Faruk Akgul BIRMINGHAM - MUMBAI www.it-ebooks.info ZeroMQ Copyright © 2013 Packt Publishing All rights reserved No part of this book may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, without the prior written permission of the publisher, except in the case of brief quotations embedded in critical articles or reviews Every effort has been made in the preparation of this book to ensure the accuracy of the information presented However, the information contained in this book is sold without warranty, either express or implied Neither the author, nor Packt Publishing, and its dealers and distributors will be held liable for any damages caused or alleged to be caused directly or indirectly by this book Packt Publishing has endeavored to provide trademark information about all of the companies and products mentioned in this book by the appropriate use of capitals However, Packt Publishing cannot guarantee the accuracy of this information First published: March 2013 Production Reference: 1140313 Published by Packt Publishing Ltd Livery Place 35 Livery Street Birmingham B3 2PB, UK ISBN 978-1-78216-104-2 www.packtpub.com Cover Image by Abhishek Pandey (abhishek.pandey1210@gmail.com) www.it-ebooks.info Credits Author Project Coordinator Faruk Akgul Amigya Khurana Reviewers Proofreader Burak Arslan Maria Gould David Greco Indexer Kevin J Rice Monica Ajmera Mehta Acquisition Editor Graphics Usha Iyer Valentina D'silva Commissioning Editor Harsha Bharwani Production Coordinator Manu Joseph Technical Editor Cover Work Hardik Soni Manu Joseph Copy Editors Insiya Morbiwala Alfida Paiva Laxmi Subramanian www.it-ebooks.info About the Author Faruk Akgul is a developer and an Emacs user who loves using open source software and frequently contributes to some open source projects He specializes in Python but enjoys experiencing new programming languages as well He likes to travel when he's not coding Thanks to Pieter Hintjens and all the contributors who helped in making this software available www.it-ebooks.info About the Reviewers Burak Arslan is the technical lead at Arskom, a quarter-century-old Turkish Software and IT infrastructure services company focusing on bundling the latest products in Satellite Communications with its value-added solutions His current job involves working as a full-stack web developer where he gets to design and implement the UX, frontend, and backend code, as well as administering the underlying IP network and hardware infrastructure, while also having an influence in managing customer relations and the future strategy and planning of his company He has a BSc in Computer Engineering from Galatasaray University and an MSc in Computer Science from Sabanci University, both in Istanbul, Turkey David Greco is an experienced software architect with more than 20 years of working experience After an initial period as a researcher in the field of high performance computing, he started working as a consultant in the professional services organizations of leading software companies such as BEA Systems, IONA, Progress, and FuseSource As a consultant, he has mainly helped customers to design and develop complex distributed platforms and service-oriented architectures Lately, he worked as a CTO for one of the most successful gambling and poker online companies in Italy David is now working as a CTO for a startup, Eligotech, developing a parallel business intelligence platform based on very popular big data technologies www.it-ebooks.info Kevin Rice has been involved in computing since the mid 80s, starting with a TI-99/4A and Commodore 64 His current skill set includes Unix, C/C++, PERL, Python, infosec, and network-monitoring related tools I'd like to thank Packt Publishing and Harsha Bharwani for allowing me the opportunity to review this book www.it-ebooks.info www.PacktPub.com Support files, eBooks, discount offers and more You might want to visit www.PacktPub.com for support files and downloads related to your book Did you know that Packt offers eBook versions of every book published, with PDF and ePub files available? You can upgrade to the eBook version at www.PacktPub com and as a print book customer, you are entitled to a discount on the eBook copy Get in touch with us at service@packtpub.com for more details At www.PacktPub.com, you can also read a collection of free technical articles, sign up for a range of free newsletters and receive exclusive discounts and offers on Packt books and eBooks TM http://PacktLib.PacktPub.com Do you need instant solutions to your IT questions? PacktLib is Packt's online digital book library Here, you can access, read and search across Packt's entire library of books Why Subscribe? • Fully searchable across every book published by Packt • Copy and paste, print and bookmark content • On demand and accessible via web browser Free Access for Packt account holders If you have an account with Packt at www.PacktPub.com, you can use this to access PacktLib today and view nine entirely free books Simply use your login credentials for immediate access www.it-ebooks.info www.it-ebooks.info Table of Contents Preface 1 Chapter 1: Getting Started The beginning The message queue Introduction to ZeroMQ 10 Simplicity 11 Performance 11 The brokerless design 11 Hello world 11 The request-reply pattern 15 Reply 15 Request 16 Sending the message 16 Handling strings in C 17 Checking the ZeroMQ version 18 Summary 19 Chapter 2: Introduction to Sockets The publish-subscribe pattern Filtering out messages The socket options 21 21 27 32 Subscription 33 Unsubscription 33 Notes on the publisher-subscriber pattern The pipeline pattern The divide and conquer strategy The ZMQ_PULL socket The ZMQ_PUSH socket www.it-ebooks.info 33 34 34 40 40 Chapter for(;;) { zstr_sendm(pub, "Company1"); zstr_send(pub, "Company Message to be ignored."); zstr_sendm(pub, "Company10"); zstr_send(pub, "Company message to receive."); zclock_sleep(10); } zsocket_destroy(context, pub); zctx_destroy(&context); return 0; } And the following is the client code: /* PUB – SUB envelop messages client.c */ #include "czmq.h" int main (int argc, char const *argv[]) { zctx_t* context = zctx_new(); void* request = zsocket_new(context, ZMQ_SUB); printf("Starting client \n"); zsocket_connect(request, "tcp://localhost:4040"); zsocket_set_subscribe (request, "Company10"); for(;;) { char* env = zstr_recv(request); char* msg = zstr_recv(request); printf("env: %s | %s\n", env, msg); if(!msg) break; [ 81 ] www.it-ebooks.info Advanced Patterns free(env); free(msg); zclock_sleep(1); } zsocket_destroy(context, request); zctx_destroy(&context); return 0; } High watermark When messages are sent from source node to destination node very rapidly, the source node could run out of memory There are quite a few solutions to this, such as flow management However, it may not be feasible in some situations ZeroMQ uses a high watermark to set the capacity of pipes In ZeroMQ v2.x, the default value is infinite whereas in ZeroMQ v3.x the default value is 1,000 When a socket reaches a high watermark, it either drops the message or blocks it The REQ-REP socket will block the message whereas PUB will drop it The following is an example: /* HWM example */ #include "czmq.h" int main (int argc, char const *argv[]) { zctx_t* context = zctx_new(); void* pub = zsocket_new(context, ZMQ_PUB); zsocket_bind(pub, "tcp://*:4040"); zsocket_set_hwm(pub, 10); [ 82 ] www.it-ebooks.info Chapter for(;;) { zstr_sendm(pub, "Company1"); zstr_send(pub, "Message to be ignored."); zstr_sendm(pub, "Company10"); zstr_send(pub, "Message to receive."); zclock_sleep(10); } zsocket_destroy(context, pub); zctx_destroy(&context); return 0; } Reliability Applications may crash unexpectedly, stop responding, can have memory leaks, or a bug can make them run slower In addition to problems that an application may have, we may experience hardware failures or network problems We need to be sure that messages arrive at their destination no matter what problems our infrastructure may experience Reliability means every event is guaranteed to arrive at its destination Most message queue implementations rely on a broker to have reliability, which means messages are queued and then delivered to their destinations, whereas in ZeroMQ, applications directly communicate with each other and messages are resent if they are lost for some reason It is easy to figure out if either the server or the client stops responding when we use the request-reply pattern If the client or the server does not receive messages from each other, it means there is a problem If you recall from Chapter 2, Introduction to Sockets, we said that the publisher does not know whether a subscriber is connected or not This also means that if a subscriber starts experiencing problems, the publisher will not know about it and the subscriber will miss messages the publisher has been transmitting When it comes to reliability in the publish-subscribe pattern, we need bidirectional communication between the publisher and the subscribers However, the publishersubscriber pattern does not support bidirectional communication in ZeroMQ, therefore, the option is to use the dealer-router pattern [ 83 ] www.it-ebooks.info Advanced Patterns Having reliability in the request-reply pattern is relatively easier than in the publish-subscribe pattern We could simply retry sending the message if we have not received a reply yet If we still not get a reply after trying a number of times, we could discard the communication Heartbeating is a layer that can be used to detect if a worker has died or is alive However, it should not be used with the request-reply pattern Heartbeating travels asynchronously between resources If there are a limited number of subscribers connected to the publisher then TCP is fine, whereas if there are massive number of subscribers, in that case, it would be a better idea to use PGM Slow subscribers in a publish-subscribe pattern A serious issue of the publish-subscribe pattern is slow subscribers A flawless environment would be one where the publisher sends messages to the subscriber at full speed, but this is utopia In reality, subscribers cannot keep up with the publisher most of the time They are either poorly implemented, have network issues, or some other reason Let's consider the following example where the subscriber runs slower and we abort the program First, let's look at the server code: #include #include #include #include #include #include "zmq.h" int main (int argc, char const *argv[]) { void* context = zmq_ctx_new(); void* publisher = zmq_socket(context, ZMQ_PUB); printf("Starting Server \n"); zmq_bind(publisher, "tcp://*:4040"); for(;;) { time_t current_time = time(NULL) % 86400; char str[11]; snprintf(str, sizeof str, "%lu", current_time); int s_len = strlen(str); [ 84 ] www.it-ebooks.info Chapter zmq_msg_t message; zmq_msg_init_size(&message, s_len); memcpy(zmq_msg_data(&message), str, s_len); zmq_msg_send(&message, publisher, 0); zmq_msg_close(&message); sleep(1); } zmq_close(publisher); zmq_ctx_destroy(context); return 0; } And the subscriber that runs slower: #include #include #include #include #include #include #include "zmq.h" #define DELAY int main (int argc, char const *argv[]) { void* context = zmq_ctx_new(); void* subscriber = zmq_socket(context, ZMQ_SUB); printf("Getting data \n"); int conn = zmq_connect(subscriber, "tcp://localhost:4040"); conn = zmq_setsockopt(subscriber, ZMQ_SUBSCRIBE, 0, 0); int i ; for(i = 0; i < 10; i++) { time_t current_time = time(NULL) % 86400; zmq_msg_t reply; zmq_msg_init(&reply); zmq_msg_recv(&reply, subscriber, 0); [ 85 ] www.it-ebooks.info Advanced Patterns int length = zmq_msg_size(&reply); char* value = malloc(length + 1); memcpy(value, zmq_msg_data(&reply), length); zmq_msg_close(&reply); unsigned long t_timer; sscanf(value, "%lu", &t_timer); int res = abs(current_time - t_timer); free(value); if(res > DELAY) { printf("Subscriber is too slow Aborting.\n"); break; } sleep(3); } zmq_close(subscriber); zmq_ctx_destroy(context); return 0; } We have defined a DELAY constant in our subscriber code and we calculate the time the server takes to send a message and the local time of the subscriber If the difference between these values is larger than the DELAY constant, we abort the subscriber as it means it runs slower This is also known as suicidal snail pattern in ZeroMQ terminology Summary In this chapter we briefly looked at some advanced patterns, reliability, and how to deal with slow subscribers in the publish-subscribe pattern ZeroMQ is a flexible, easy-to-use, and fast message queuing service Unlike other message queuing libraries, it allows developers to implement their own message queuing services [ 86 ] www.it-ebooks.info Appendix Structure and Interpretation of Computer Programs, Second Edition, Abelson Harold, Gerald Jay Sussman, and Julie Sussman, McGraw-Hill Science, 1996 Fuzz revisited: A re-examination of the reliability of Unix utilities and services, Barton P Miller, David Koski, Cjin Pheow, Lee Vivekananda Maganty, Ravi Murthy, Ajitkumar Natarajan, and Jeff Steidl, 1995 CSSV: Towards a Realistic Tool for Statically Detecting All Buffer Overflows In C, Nurit Dor, Michael Rodeh, and Mooly Sagiv, 2003 Beej's Guide to Unix IPC, Brian "Beej Jorgensen" Hall, available at http://beej.us/guide/bgipc/output/html/multipage/index.html and viewed on October 22, 2012 ZeroMQ – The Guide, Pieter Hintjens, available at http://zguide.zeromq.org/ and viewed on November 4, 2012 ZeroMQ – API, Pieter Hintjens, available at http://api.zeromq.org/ and viewed on October 17, 2012 CZMQ – High Level C Binding for ZeroMQ, Pieter Hintjens, available at http://czmq.zeromq.org/ and viewed on November 6, 2012 A TCP Tutorial, Andy Ogielski available at http://www.ssfnet.org/Exchange /tcp/tcpTutorialNotes.html and viewed on October 15, 2012 An Introduction to Asyncronous Programming and Twisted, Dave Peticolas, 2011, available at http://krondo.com/blog/?page_id=1327 and viewed on September 12, 2012 ZeroMQ an Introduction, Nicholas Piël, 2010, available at http://nichol.as/ zeromq-an-introduction www.it-ebooks.info Appendix Valgrind Manual, Julian Seward, available at http://valgrind.org/docs/manual/ quick-start.html#quick-start.intro and viewed on October 17, 2012 Cloud-based Queuing System with Strong Consistency, Zhe Zhang, Han Chen, Minkyong Kim, and Hui Lei, 2011 Message Queue Evaluation Notes, Second Life, available at http://wiki.secondlife com/wiki/Message_Queue_Evaluation_Notes#Zero_MQ and viewed on September 15, 2012 [ 88 ] www.it-ebooks.info Index A AIO 9, 10 Asynchronous Input/Output See  AIO B Beej Guide URL 87 broadcast 52 C C strings, handling 17, 18 connectionless sockets 46 CZMQ about 64 URL 87 zclock 75 zctx 64 zfile 68, 69 zfile_mkdir 70 zhash 71 zlist 74 zloop 65, 66 zmsg 67 zstr_send 65 zthread 75 D DARPA Internet addresses (Internet Sockets) 45 datagram sockets, internet sockets 46 definitely lost 43 DELAY constant 86 distributed denial of service attack (DDoS) 10 divide-and-conquer strategy 34-39 E Encapsulated Pragmatic General Multicast See  EPGM EPGM 52 F fair-queue strategy 15 FIFO (First In First Out) queue flags, TCP 49 full-duplex operation 50 G geocast 52 green threads and native threads, differences 78 H header, TCP 49 heartbeating 84 Hello world request-reply architecture 14 request-reply pattern 15 writing 11-13 helper functions, zfile 68 www.it-ebooks.info I O indirectly lost 43 INPROC 53 internet sockets about 45 datagram sockets 46 raw sockets 46 stream sockets 45 interruptions handling 60-64 Inter-thread Transport See  INPROC I/O threads setting 53 OpenPGM 52 K kill -9 command 61 L libzfl library 75 M memory leaks detecting 42 message filtering 27-32 sending 16, 17 message queue 7-9 multicast 51 multi-part messages 57-60 multiple sockets about 53 zmq_poll(3) used 53 ZMQ_PULL used 55 ZMQ_PUSH used 55 multithreaded applications writing, with ZeroMQ 78, 79 N native threads and green threads, differences 78 notify 21 P PF_INET 45 PF_UNIX 45 pipeline pattern about 34 divide-and-conquer strategy 34-39 ZMQ_PULL socket 40 ZMQ_PUSH socket 40 possibly lost 43 POSIX signal 60 Pragmatic General Multicast (PGM) 52 processes 41 publish 21 publisher-subscriber messages wrapping 80, 81 publish-subscribe pattern about 21, 22 client code, sample output 25 messages, filtering 27, 28 notes 33, 34 notify 21 publish 21 reliability 83, 84 slow subscribers 84-86 socket, options 32 subscribe 21 unsubscribe 21 PUB-SUB sockets 80 PULL socket 39 PUSH socket 39 R raw sockets, internet sockets 46 reliability, publish-subscribe pattern 83, 84 reply part, request-reply pattern fair-queue strategy 15 REQ-REP socket 82 request part, request-reply pattern 16 request-reply architecture 14 14 [ 90 ] www.it-ebooks.info request-reply pattern about 15 extending 77, 78 reply part 15 request part 16 RFC 793 guide 47 routing schemes about 51 broadcast 52 geocast 52 multicast 51 unicast 51 S SIGINT signal 61 SIGINT SIGTERM signal 60 SIGKILL signal 61 SIGTERM signal 60 slow subscribers, publish-subscribe pattern 84-86 SOCK_DGRAM See  datagram sockets, internet sockets socket about 45 internet socket, types 45, 46 limiting 53 socket API 45 socket options, publish-subscribe pattern about 32 subscription 33 unsubscription 33 SOCK_RAW See  raw sockets, internet sockets SOCK_STREAM See  stream sockets, internet sockets stream sockets, internet sockets 45 subscribe 21 subscriptions 24 T TCP about 47 flags 49 header 49 properties 50 sockets 47 three-way handshake protocol 47 TCP, properties flow-control 50 full-duplex 50 multiplexing 50 reliability 50 TCP sockets and ZeroMQ sockets, differences 50, 51 TCP Tutorial URL 87 three-way handshake protocol 47, 48 Transmission Control Protocol See  TCP U unicast 51, 52, 53 unsubscribe 21 V Valgrind 42, 43 Z zclock, CZMQ 75 zctx, CZMQ 64 ZeroMQ about 7, 10 brokerless design 11 high watermark 82 multithreaded applications, writing with 78, 79 performance 11 simplicity 11 sockets and TCP sockets, differences 50 TCP flags 49 URL 87 version, checking 18 ZeroMQ context destroying 41 getting 40 ZeroMQ sockets and TCP sockets, differences 50, 51 [ 91 ] www.it-ebooks.info zfile_delete, helper function 68 zfile_exists, helper function 68 zfile_mkdir, helper function 68, 70 zfile_send, CZMQ about 68 zfile_delete 68 zfile_exists 68 zfile_mkdir 68-70 zfile_size 68 zfile_size, helper function 68 zlist, CZMQ 74 zloop_send, CZMQ 65, 66 zmq_ctx_new() method 14 zmq_msg_recv parameters 17 zmq_msg_send parameters 16 zmq_msg sockets 57 ZMQ_PULL socket 40 ZMQ_PUSH socket 40 ZMQ_REP socket 14, 15 ZMQ_REQ 16 ZMQ_SNDMORE flag 57, 60 zmsg_send, CZMQ 67 zstr_send, CZMQ 65 zthread, CZMQ 75 [ 92 ] www.it-ebooks.info Thank you for buying ZeroMQ About Packt Publishing Packt, pronounced 'packed', published its first book "Mastering phpMyAdmin for Effective MySQL Management" in April 2004 and subsequently continued to specialize in publishing highly focused books on specific technologies and solutions Our books and publications share the experiences of your fellow IT professionals in adapting and customizing today's systems, applications, and frameworks Our solution based books give you the knowledge and power to customize the software and technologies you're using to get the job done Packt books are more specific and less general than the IT books you have seen in the past Our unique business model allows us to bring you more focused information, giving you more of what you need to know, and less of what you don't Packt is a modern, yet unique publishing company, which focuses on producing quality, cutting-edge books for communities of developers, administrators, and newbies alike For more information, please visit our website: www.packtpub.com About Packt Open Source In 2010, Packt launched two new brands, Packt Open Source and Packt Enterprise, in order to continue its focus on specialization This book is part of the Packt Open Source brand, home to books published on software built around Open Source licences, and offering information to anybody from advanced developers to budding web designers The Open Source brand also runs Packt's Open Source Royalty Scheme, by which Packt gives a royalty to each Open Source project about whose software a book is sold Writing for Packt We welcome all inquiries from people who are interested in authoring Book proposals should be sent to author@packtpub.com If your book idea is still at an early stage and you would like to discuss it first before writing a formal book proposal, contact us; one of our commissioning editors will get in touch with you We're not just looking for published authors; if you have strong technical skills but no writing experience, our experienced editors can help you develop a writing career, or simply get some additional reward for your expertise www.it-ebooks.info RESTful PHP Web Services ISBN: 978-1-847195-52-4 Paperback: 220 pages Learn the basic architectural concepts and steps through examples of consuming and creating RESTful web services in PHP Get familiar with REST principles Learn how to design and implement PHP web services with REST Real-world examples, with services and client PHP code snippets Introduces tools and frameworks that can be used when developing RESTful PHP applications ASP.NET 3.5 Application Architecture and Design ISBN: 978-1-847195-50-0 Paperback: 260 pages Build robust, scalable ASP.NET applications quickly and easily Master the architectural options in ASP.NET to enhance your applications Develop and implement n-tier architecture to allow you to modify a component without disturbing the next one Design scalable and maintainable web applications rapidly Please check www.PacktPub.com for information on our titles www.it-ebooks.info Mastering OpenLDAP: Configuring, Securing and Integrating Directory Services ISBN: 978-1-847191-02-1 Paperback: 484 pages Configuring, Securing, and Integrating Directory Services Up-to-date with the latest OpenLDAP release Installing and configuring the OpenLDAP server Synchronizing multiple OpenLDAP servers over the network Creating custom LDAP schemas to model your own information Catalyst ISBN: 978-1-847190-95-6 Paperback: 200 pages Design, develop, test, and deploy applications with the open-source Catalyst MVC framework Understand the Catalyst Framework and MVC architecture Build and test a site with Catalyst Detailed walkthroughs to create sample applications Extend Catalyst through plug-ins Please check www.PacktPub.com for information on our titles www.it-ebooks.info ... "tcp://localhost:4040"); zmq_close(request); zmq_term(context); return 0; } Any command-line input or output is written as follows: gcc -Wall -lzmq -o zero zero.c When we say zmq_socket(2) we mean zmq_socket... divide and conquer strategy The ZMQ_PULL socket The ZMQ_PUSH socket www.it-ebooks.info 33 34 34 40 40 Table of Contents Getting ZeroMQ context 40 Destroying ZeroMQ context 41 Cleaning up 41 Detecting... following software will be required: • ZeroMQ v3.2, available at http://www.zeromq.org/ • CZMQ v1.3.1, available at http://czmq.zeromq.org/ www.it-ebooks.info Preface • Microsoft Visual C++ (to build