DOCSLIB.ORG

Eider Documentation Release 1.0.0

Total Page：16

File Type：pdf, Size：1020Kb

Download full-text PDF Read full-text
Eider Documentation Release 1.0.0 Eider Documentation Release 1.0.0 Bart Robinson Oct 09, 2019 Contents 1 Installation 3 1.1 Python..................................................3 1.2 JavaScript.................................................3 1.3 C++....................................................4 2 Getting Started 5 2.1 Python..................................................5 2.2 JavaScript.................................................6 2.3 C++....................................................7 3 Contents 9 3.1 Justification................................................9 3.2 Concepts................................................. 10 3.3 Protocol.................................................. 13 3.4 Conventions............................................... 18 4 Blame 23 Index 25 i ii Eider Documentation, Release 1.0.0 Eider is an object-oriented, asynchronous, late-binding, web-first, polyglot RPC protocol. Eider is also the name of the reference implementations in Python and JavaScript. Out of the box, Eider uses WebSockets for transport and JSON or MessagePack for serialization. The core protocol and concepts are transport- and format-neutral. With Eider, developing applications that combine server-side, client-side, and in-browser code is duck soup! Contents 1 Eider Documentation, Release 1.0.0 2 Contents CHAPTER 1 Installation 1.1 Python Works in CPython 3.4+ and PyPy3. Requires either aiohttp or websockets. Includes elective support for MessagePack using msgpack-python, if available. pip install eider # either: pip install aiohttp # recommended pip install websockets # slower # optional: pip install msgpack You can also check out the source code on GitHub. 1.2 JavaScript Works in Node.js 6+, modern browsers, and any other environment that supports ES6. For clients, no external libraries are strictly required. Node.js servers need the ws package. Other optional dependen- cies are msgpack-lite for MessagePack encoding and weak for implicit remote garbage collection. npm install eider-rpc # for servers: npm install ws # optional: npm install msgpack-lite npm install weak 3 Eider Documentation, Release 1.0.0 For the browser: eider-rpc.min.js. You can also check out the source code on GitHub. 1.3 C++ The eider-pybind11 project provides a simple header file that can enable classes implemented in C++ to be served over Eider connections using pybind11. 4 Chapter 1. Installation CHAPTER 2 Getting Started 2.1 Python Here is a simple server (simple_server.py): 1 import eider 2 3 class DuckTester(eider.LocalRoot): 4 5 def is_it_a_duck(self, obj): 6 return ( 7 obj['looks'] =='like a duck' and 8 obj['swims'] =='like a duck' and 9 obj['quacks'] =='like a duck') 10 11 eider.serve(12345, root=DuckTester) And here is a corresponding client (simple_client.py): 1 import eider 2 3 how='like a duck' 4 obj={'looks': how,'swims': how,'quacks': how} 5 6 with eider.BlockingConnection('ws://localhost:12345') as conn: 7 with conn.create_session() as duck_tester: 8 is_duck= duck_tester.is_it_a_duck(obj) 9 print("It's probably"+("" if is_duck else "NOT")+"a duck.") And here is an equivalent client using non-blocking APIs: (simple_client_async.py): 1 import asyncio, eider 2 3 how='like a duck' (continues on next page) 5 Eider Documentation, Release 1.0.0 (continued from previous page) 4 obj={'looks': how,'swims': how,'quacks': how} 5 6 async def ducktest(): 7 async with eider.Connection('ws://localhost:12345') as conn: 8 async with conn.create_session() as duck_tester: 9 is_duck= await duck_tester.is_it_a_duck(obj) 10 print("It's probably"+("" if is_duck else "NOT")+"a duck.") 11 12 asyncio.run(ducktest()) 2.2 JavaScript Here is an equivalent server in JavaScript (simple_server.js): 1 const Eider= require('eider-rpc'); 2 3 class DuckTester extends Eider.LocalRoot { 4 is_it_a_duck(obj) { 5 return obj.looks === 'like a duck'&& 6 obj.swims === 'like a duck'&& 7 obj.quacks === 'like a duck'; 8 } 9 } 10 11 Eider.serve(12345, {root: DuckTester}); And here is an equivalent client (simple_client.html): 1 <script src="eider-rpc.min.js"></script> 2 <script type="text/javascript"> 3 const how= 'like a duck'; 4 const obj= {looks: how, swims: how, quacks: how}; 5 Eider.using(Eider.connect('ws://localhost:12345'), conn => 6 Eider.using(conn.createSession(), duckTester => 7 duckTester.is_it_a_duck(obj).then(isDuck => { 8 alert("It's probably "+ (isDuck?'': 'NOT ')+ 'a duck.'); 9 }) 10 ) 11 ); 12 </script> And here is an equivalent client using async/await syntax (simple_client_async.html): 1 <script src="eider-rpc.min.js"></script> 2 <script type="text/javascript"> 3 const how= 'like a duck'; 4 const obj= {looks: how, swims: how, quacks: how}; 5 (async () => 6 await Eider.using(Eider.connect('ws://localhost:12345'), async conn => 7 await Eider.using(conn.createSession(), async duckTester => { 8 const isDuck= await duckTester.is_it_a_duck(obj); 9 alert("It's probably "+ (isDuck?'': 'NOT ')+ 'a duck.'); 10 }) 11 ) (continues on next page) 6 Chapter 2. Getting Started Eider Documentation, Release 1.0.0 (continued from previous page) 12 )(); 13 </script> 2.3 C++ Here is how the core of the Python server could be written in C++ (simple_server.cpp): 1 #include <eider_pybind11.hpp> 2 3 using namespace eider_pybind11; 4 5 struct DuckTester : LocalRoot { 6 using LocalRoot::LocalRoot; 7 8 bool is_it_a_duck(py::object obj) { 9 return std::string(py::str(obj["looks"]))=="like a duck"&& 10 std::string(py::str(obj["swims"]))=="like a duck"&& 11 std::string(py::str(obj["quacks"]))=="like a duck"; 12 } 13 }; 14 15 PYBIND11_MODULE(ducktest, m) { 16 bind(m); 17 18 py::class_<DuckTester, LocalRoot>(m,"DuckTester") 19 .def(py::init<LocalSession>()) 20 .def("is_it_a_duck",&DuckTester::is_it_a_duck); 21 } 2.3. C++ 7 Eider Documentation, Release 1.0.0 8 Chapter 2. Getting Started CHAPTER 3 Contents 3.1 Justification (a.k.a. Yet another RPC protocol?) There are many Remote Procedure Call mechanisms out there. Some of them are very nice. Eider was developed because, as far as the author could tell, no single one of them meets all five of these criteria: • Object-oriented. Many RPC protocols only allow you to call a flat list of exposed functions. Eider lets you work with remote objects and their exposed methods. • Asynchronous. Many RPC protocols require that responses be returned in the same order as requests were sent. Eider allows responses to be returned in any order, using asynchronous fulfillment mechanisms such as Promises (in JavaScript) and Futures (in Python). • Late-binding. Many RPC protocols require invokable function signatures to be declared ahead of time in some special way. Eider has no such requirement; instead it follows the Python tradition of duck typing (if it looks like a duck, swims like a duck, and quacks like a duck. it’s probably a duck). There is no interface description language; exposed objects and methods are coded using the natural syntax of their native language. Type mismatches are reported via exceptions at runtime.1 • Web-first. Many RPC protocols use direct TCP or pipe connections and rely on custom binary formats or overly-verbose XML, all of which make them difficult-to-impossible to use from JavaScript running inside the browser. Eider uses web standards like WebSockets and JSON, so client-side web apps can be first-class participants in an Eider-based system. • Polyglot. Many RPC protocols are tied to a single programming language. Eider is language-agnostic. Eider also has these nice features: • Lightweight. The Python and JavaScript implementations are just a few kilobytes each and have minimal external dependencies. Transmitted messages are nearly as compact as in JSON-RPC. 1 It is important not to confuse late binding with weak typing. Eider methods are precisely as strongly typed as the language used to implement them. To assist with coding discipline, Eider has built-in support for function annotation, interactive help, and runtime object inspection. 9 Eider Documentation, Release 1.0.0 • Natural syntax. Syntactic sugar is used to make calling remote methods and accessing remote properties as natural as possible. The Python implementation also provides blocking versions of client functions, so simple clients can avoid the complexity of Futures and callbacks. • Peer-to-peer. After the initial connection, there is no functional difference between client and server applica- tions. Each peer can be both a provider and consumer of remote interfaces. Callbacks are even supported, where a locally-provided object or method is passed to a remote interface. • Built-in proxying. Any Eider peer can act as a bridge between any two of its peers, allowing them to call each other’s methods without connecting directly. • Cancellation. Eider consumers can request the graceful cancellation of long-running remote method calls without terminating the connection or losing session state. 3.2 Concepts Note: For simplicity, in this document we will prefer the Python blocking (synchronous) API. The asynchronous JavaScript and Python APIs are very similar. 3.2.1 Outline Typical Eider communication follows this basic pattern: 1. Establish a connection. 2. Create a remote session to contain object references. 3. Call a method on the root object of the session. 4. Call any other desired methods on the root object or on returned objects. 5. Close session(s) to reclaim memory. 6. Repeat 2-5 as desired. 7. (concurrently with 2-6) Execute any incoming method calls requested by the connection peer. 8. Close the connection. Steps 2-7 are entirely optional; remember, every Eider peer can be a
Load more

Recommended publications
  • Msgpack Documentation Release 1.0
    msgpack Documentation Release 1.0 Author 2021-03-18 Contents 1 API reference 3 2 Advanced usage 9 Python Module Index 11 Index 13 i ii msgpack Documentation, Release 1.0 MessagePack is a efficient format for inter language data exchange. Contents 1 msgpack Documentation, Release 1.0 2 Contents CHAPTER 1 API reference msgpack.pack(o, stream, **kwargs) Pack object o and write it to stream See Packer for options. dump() is alias for pack() msgpack.packb(o, **kwargs) Pack object o and return packed bytes See Packer for options. dumps() is alias for packb() msgpack.unpack(stream, **kwargs) Unpack an object from stream. Raises ExtraData when stream contains extra bytes. See Unpacker for options. load() is alias for unpack() msgpack.unpackb(packed, *, object_hook=None, list_hook=None, bool use_list=True, bool raw=False, int timestamp=0, bool strict_map_key=True, unicode_errors=None, object_pairs_hook=None, ext_hook=ExtType, Py_ssize_t max_str_len=-1, Py_ssize_t max_bin_len=-1, Py_ssize_t max_array_len=-1, Py_ssize_t max_map_len=-1, Py_ssize_t max_ext_len=-1) Unpack packed_bytes to object. Returns an unpacked object. Raises ExtraData when packed contains extra bytes. Raises ValueError when packed is incomplete. Raises FormatError when packed is not valid msgpack. Raises StackError when packed contains too nested. Other exceptions can be raised during unpacking. See Unpacker for options. max_xxx_len options are configured automatically from len(packed). loads() is alias for unpackb() 3 msgpack Documentation, Release 1.0 class msgpack.Packer(default=None, *, bool use_single_float=False, bool autoreset=True, bool use_bin_type=True, bool strict_types=False, bool datetime=False, uni- code_errors=None) MessagePack Packer Usage: packer= Packer() astream.write(packer.pack(a)) astream.write(packer.pack(b)) Packer’s constructor has some keyword arguments: Parameters • default (callable) – Convert user type to builtin type that Packer supports.
    [Show full text]
  • Advanced JSON Handling in Go 19:40 05 Mar 2020 Jonathan Hall Devops Evangelist / Go Developer / Clean Coder / Salsa Dancer About Me
    Advanced JSON handling in Go 19:40 05 Mar 2020 Jonathan Hall DevOps Evangelist / Go Developer / Clean Coder / Salsa Dancer About me Open Source contributor; CouchDB PMC, author of Kivik Core Tech Lead for Lana Former eCommerce Dev Manager at Bugaboo Former backend developer at Teamwork.com Former backend developer at Booking.com Former tech lead at eFolder/DoubleCheck 2 Show of hands Who has... ...used JSON in a Go program? ...been frustrated by Go's strict typing when dealing with JSON? ...felt limited by Go's standard JSON handling? What have been your biggest frustrations? 3 Today's Topics Very brief intro to JSON in Go Basic use of maps and structs Handling inputs of unknown type Handling data with some unknown fields 4 A brief intro to JSON JavaScript Object Notation, defined by RFC 8259 Human-readable, textual representation of arbitrary data Limted types: null, Number, String, Boolean, Array, Object Broad applications: Config files, data interchange, simple messaging 5 Alternatives to JSON YAML, TOML, INI BSON, MessagePack, CBOR, Smile XML ProtoBuf Custom/proprietary formats Many principles discussed in this presentation apply to any of the above formats. 6 Marshaling JSON Creating JSON from a Go object is (usually) very straight forward: func main() { x := map[string]string{ "foo": "bar", } data, _ := json.Marshal(x) fmt.Println(string(data)) } Run 7 Marshaling JSON, #2 Creating JSON from a Go object is (usually) very straight forward: func main() { type person struct { Name string `json:"name"` Age int `json:"age"` Description string `json:"descr,omitempty"` secret string // Unexported fields are never (un)marshaled } x := person{ Name: "Bob", Age: 32, secret: "Shhh!", } data, _ := json.Marshal(x) fmt.Println(string(data)) } Run 8 Unmarshaling JSON Unmarshaling JSON is often a bit trickier.
    [Show full text]
  • Performance Comparison of Data Serialization Schemes for ETSI ITS Car-To-X Communication Systems
    International Journal on Advances in Telecommunications, vol 8 no 1 & 2, year 2015, http://www.iariajournals.org/telecommunications/ 48 Performance Comparison of Data Serialization Schemes for ETSI ITS Car-to-X Communication Systems Sebastian Bittl, Arturo A. Gonzalez, Michael Spahn,¨ and Wolf A. Heidrich Fraunhofer ESK Munich, Germany Email: fsebastian.bittl, arturo.gonzalez, michael.spaehn, [email protected] Abstract—Wireless Car-to-X communication is about to enter sense collision avoidance mechanism (CSMA-CA) for multi- the mass market in upcoming years. The non-licensed, but user channel access, longer packets imply longer transmission reserved bandwidth for such communications is relatively narrow times and hence a higher channel busy ratio. This means that in terms of the few usable channels and the expected number nodes near a transmitter, which are willing to transmit as well, of communicating entities. Among other communication aspects, must wait longer until the channel is free to use. Moreover, data serialization schemes that allow compact encoding as well as the wireless channel has a limited capacity allowing only a fast encoding and decoding are required. Compact representation of data helps in keeping a minimal bandwidth overhead in limited number of transmitted bits per unit of time. The lower the wireless channel. Moreover, since delay is an important the number of transmitted messages, the higher the number of performance parameter in Car-to-X communication, the pro- users that could use the given frequency spectrum in parallel. cessing time of the serialization/deserialization schemes shall be kept to a minimum. So far, no detailed analysis of different The data serialization schemes also influence processing data serialization schemes for Car-to-X communication regarding power requirements in both ETSI Intelligent Transport Sys- important properties such as runtime, memory consumption tems (ITS) in Europe [2] and Wireless Access in Vehicular and encoded output length has been published.
    [Show full text]
  • A Lightweight and Efficient Document Representation
    docrep: A lightweight and efficient document representation framework Tim Dawborn and James R. Curran -lab,e School of Information Technologies University of Sydney NSW 2006, Australia tim.dawborn,james.r.curran @sydney.edu.au { } Abstract Modelling linguistic phenomena requires highly structured and complex data representations. Document representation frameworks (DRFs) provide an interface to store and retrieve multiple annotation layers over a document. Researchers face a difficult choice: using a heavy-weight DRF or implement a custom DRF. The cost is substantial, either learning a new complex system, or continually adding features to a home-grown system that risks overrunning its original scope. We introduce DOCREP, a lightweight and efficient DRF, and compare it against existing DRFs. We discuss our design goals and implementations in C++, Python, and Java. We transform the OntoNotes 5 corpus using DOCREP and UIMA, providing a quantitative comparison, as well as discussing modelling trade-offs. We conclude with qualitative feedback from researchers who have used DOCREP for their own projects. Ultimately, we hope DOCREP is useful for the busy researcher who wants the benefits of a DRF, but has better things to do than to write one. 1 Introduction Computational Linguistics (CL) is increasingly a data-driven research discipline with researchers us- ing diverse collections of large-scale corpora (Parker et al., 2011). Representing linguistic phenomena can require modelling intricate data structures, both flat and hierarchical, layered over the original text; e.g. tokens, sentences, parts-of-speech, named entities, coreference relations, and trees. The scale and complexity of the data demands efficient representations. A document representation framework (DRF) should support the creation, storage, and retrieval of different annotation layers over collections of hetero- geneous documents.
    [Show full text]
  • Package 'Rcppmsgpack'
    Package ‘RcppMsgPack’ November 18, 2018 Type Package Title 'MsgPack' C++ Header Files and Interface Functions for R Version 0.2.3 Date 2018-11-18 Author Travers Ching and Dirk Eddelbuettel; the authors and contributors of MsgPack Maintainer Dirk Eddelbuettel <[email protected]> Description 'MsgPack' header files are provided for use by R packages, along with the ability to access, create and alter 'MsgPack' objects directly from R. 'MsgPack' is an efficient binary serialization format. It lets you exchange data among multiple languages like 'JSON' but it is faster and smaller. Small integers are encoded into a single byte, and typical short strings require only one extra byte in addition to the strings themselves. This package provides headers from the 'msgpack-c' implementation for C and C++(11) for use by R, particularly 'Rcpp'. The included 'msgpack-c' headers are licensed under the Boost Software License (Version 1.0); the code added by this package as well the R integration are licensed under the GPL (>= 2). See the files 'COPYRIGHTS' and 'AUTHORS' for a full list of copyright holders and contributors to 'msgpack-c'. Copyright file inst/COPYRIGHTS License GPL (>= 2) Imports Rcpp LinkingTo Rcpp, BH BugReports https://github.com/eddelbuettel/rcppmsgpack/issues RoxygenNote 6.0.1 Suggests knitr, rmarkdown, microbenchmark VignetteBuilder knitr NeedsCompilation yes Repository CRAN Date/Publication 2018-11-18 21:10:03 UTC 1 2 RcppMsgPack-package R topics documented: RcppMsgPack-package . .2 arrayEx . .3 enumEx . .4 msgpack_format . .4 msgpack_map . .5 msgpack_pack . .6 msgpack_read . .6 msgpack_simplify . .7 msgpack_timestamp_decode . .8 msgpack_timestamp_encode . .8 msgpack_unpack . .9 msgpack_write . 10 Index 11 RcppMsgPack-package ’MsgPack’ C++ Header Files and Interface Functions for R Description ’MsgPack’ header files are provided for use by R packages, along with the ability to access, create and alter ’MsgPack’ objects directly from R.
    [Show full text]
  • Enabling Digital Twins – a Comparative Study on Messaging Protocols and Serialization Formats for Digital Twins in Iov
    Linköping University | Department of Computer and Information Science Master’s thesis, 30 ECTS | Datateknik 2019 | LIU-IDA/LITH-EX-A--19/066--SE Enabling Digital Twins – A comparative study on messaging protocols and serialization formats for Digital Twins in IoV Att möjliggöra digitala tvillingar Daniel Persson Proos Supervisor : Patrick Lambrix Examiner : Niklas Carlsson Linköpings universitet SE–581 83 Linköping +46 13 28 10 00 , www.liu.se Upphovsrätt Detta dokument hålls tillgängligt på Internet - eller dess framtida ersättare - under 25 år från publicer- ingsdatum under förutsättning att inga extraordinära omständigheter uppstår. Tillgång till dokumentet innebär tillstånd för var och en att läsa, ladda ner, skriva ut enstaka ko- pior för enskilt bruk och att använda det oförändrat för ickekommersiell forskning och för undervis- ning. Överföring av upphovsrätten vid en senare tidpunkt kan inte upphäva detta tillstånd. All annan användning av dokumentet kräver upphovsmannens medgivande. För att garantera äktheten, säker- heten och tillgängligheten finns lösningar av teknisk och administrativ art. Upphovsmannens ideella rätt innefattar rätt att bli nämnd som upphovsman i den omfattning som god sed kräver vid användning av dokumentet på ovan beskrivna sätt samt skydd mot att dokumentet ändras eller presenteras i sådan form eller i sådant sammanhang som är kränkande för upphovsman- nens litterära eller konstnärliga anseende eller egenart. För ytterligare information om Linköping University Electronic Press se förlagets hemsida http://www.ep.liu.se/. Copyright The publishers will keep this document online on the Internet - or its possible replacement - for a period of 25 years starting from the date of publication barring exceptional circumstances. The online availability of the document implies permanent permission for anyone to read, to down- load, or to print out single copies for his/hers own use and to use it unchanged for non-commercial research and educational purpose.
    [Show full text]
  • Parsing Gigabytes of JSON Per Second
    Parsing Gigabytes of JSON per Second Geoff Langdale · Daniel Lemire Abstract JavaScript Object Notation or JSON is a The JSON syntax can be viewed as a restricted form ubiquitous data exchange format on the Web. Ingesting of JavaScript, but it is used in many programming lan- JSON documents can become a performance bottleneck guages. JSON has four primitive types or atoms (string, due to the sheer volume of data. We are thus motivated number, Boolean, null) that can be embedded within to make JSON parsing as fast as possible. composed types (arrays and objects). An object takes Despite the maturity of the problem of JSON pars- the form of a series of key-value pairs between braces, ing, we show that substantial speedups are possible. where keys are strings (e.g., f"name":"Jack","age":22g). We present the first standard-compliant JSON parser An array is a list of comma-separated values between to process gigabytes of data per second on a single brackets (e.g., [1,"abc",null]). Composed types can core, using commodity processors. We can use a quar- contain primitive types or arbitrarily deeply nested com- ter or fewer instructions than a state-of-the-art refer- posed types as values. See Fig. 1 for an example. The ence parser like RapidJSON. Unlike other validating JSON specification defines six structural characters (`[', parsers, our software (simdjson) makes extensive use of `f', `]', `g', `:', `,'): they serve to delimit the locations Single Instruction, Multiple Data (SIMD) instructions. and structure of objects and arrays. To ensure reproducibility, simdjson is freely available as To access the data contained in a JSON document open-source software under a liberal license.
    [Show full text]
  • JSON at Work.Pdf
    JSON at Work PRACTICAL DATA INTEGRATION FOR THE WEB Tom Marrs JSON at Work Practical Data Integration for the Web Tom Marrs Beijing Boston Farnham Sebastopol Tokyo JSON at Work by Tom Marrs Copyright © 2017 Vertical Slice, Inc. All rights reserved. Printed in the United States of America. Published by O’Reilly Media, Inc., 1005 Gravenstein Highway North, Sebastopol, CA 95472. O’Reilly books may be purchased for educational, business, or sales promotional use. Online editions are also available for most titles (http://oreilly.com/safari). For more information, contact our corporate/insti‐ tutional sales department: 800-998-9938 or [email protected]. Editor: Meg Foley Indexer: Ellen Troutman-Zaig Production Editor: Nicholas Adams Interior Designer: David Futato Copyeditor: Sharon Wilkey Cover Designer: Randy Comer Proofreader: Charles Roumeliotis Illustrator: Rebecca Demarest July 2017: First Edition Revision History for the First Edition 2017-06-16: First Release See http://oreilly.com/catalog/errata.csp?isbn=9781449358327 for release details. The O’Reilly logo is a registered trademark of O’Reilly Media, Inc. JSON at Work, the cover image, and related trade dress are trademarks of O’Reilly Media, Inc. While the publisher and the author have used good faith efforts to ensure that the information and instructions contained in this work are accurate, the publisher and the author disclaim all responsibility for errors or omissions, including without limitation responsibility for damages resulting from the use of or reliance on this work. Use of the information and instructions contained in this work is at your own risk. If any code samples or other technology this work contains or describes is subject to open source licenses or the intellectual property rights of others, it is your responsibility to ensure that your use thereof complies with such licenses and/or rights.
    [Show full text]
  • Keeping Properties with the Data CL-Metaheaders
    Published in: Bański, Piotr/Kupietz, Marc/Lüngen, Harald/Rayson, Paul/Biber, Hanno/Breiteneder, Evelyn/Clematide, Simon/Mariani, John/stevenson, Mark/Sick, Theresa (eds.): Proceedings of the Workshop on Challenges in the Management of Large Corpora and Big Data and Natural Language Processing (CMLC-5+BigNLP) 2017 including the papers from the Web-as-Corpus (WAC-XI) guest section. Birmingham, 24 July 2017. - Mannheim: Institut für Deutsche Sprache, 2017. Pp. 35-41 Keeping Properties with the Data CL-MetaHeaders - An Open Specification John Vidler Stephen Wattam [email protected] [email protected] School of Computing and Communications Lancaster University Abstract On the one hand, as a discipline, difficulties arising from the existence of a broad tool suite are Corpus researchers, along with many an excellent problem to have; a multitude of other disciplines in science are being put solutions are present to handle any number of under continual pressure to show problems we may face. However, on the other accountability and reproducibility in their hand, having no standard interoperability level for work. This is unsurprisingly difficult these tools prevents some interactions across this when the researcher is faced with a wide space without a great deal of effort from the user. array of methods and tools through which Being aware of the file type is seldom enough to to do their work; simply tracking the correctly set up reader/writer operations in a tool, operations done can be problematic, especially if we consider character encoding especially when toolchains are often differences, and the overall engineering of the configured by the developers, but left tool has become very important in some cases.
    [Show full text]
  • DISTRIBUTED COMPUTING SYSTEMS Message Queue; Data SerializaOn
    DISTRIBUTED COMPUTING SYSTEMS Message Queue; Data Serializaon © GLEB RADCHENKO 1 2 THE MESSAGE SYSTEM PARADIGM ¥ The Message System or Message-Oriented Middleware (MOM) paradigm is an elaboration of the basic message-passing paradigm. ¥ In this paradigm, a message system serves as an intermediary among separate, independent processes. ¥ The message system acts as a switch for messages, through which processes exchange messages asynchronously, in a decoupled manner. ¥ A sender deposits a message with the message system, which forwards it to a message queue associated with each receiver. Once a message is sent, the sender is free to move on to other tasks. © GLEB RADCHENKO © Prof. Elizabeth White Distributed So=ware Systems 3 USING MESSAGE MANAGER The use of message queues is oriented towards asynchronous CommuniCaon. Advanteges ¥ Decoupling: By introduCing a layer in between proCesses, message queues Create an impliCit, data-based interface that both proCesses implement. ¥ Redundancy : The put-get-delete paradigm, requires a proCess to expliCitly indiCate that it has finished proCessing a message before the message is removed from the queue. ¥ Scalability BeCause message queues deCouple your proCesses, it’s easy to sCale up the rate with whiCh messages are added to the queue or proCessed. ¥ Elascity & Spikability: appliCaon needs to be able to keep funC1oning with this inCreased load, but the traffiC is anomaly, not the standard. Message queues will allow beleaguered Components to struggle through the inCreased load. ¥ Resiliency: Message queues deCouple proCesses, so if a proCess that is proCessing messages from the queue fails, messages Can s1ll be added to the queue to be proCessed when the system reCovers ¥ Buffering: Message queues help proCess-Consuming tasks operate at peak effiCienCy by offering a buffer layer--the proCess wri1ng to the queue Can write as fast as it’s able to, instead of being Constrained by the readiness of the proCess reading from the queue.
    [Show full text]
  • Serialization Tests
    Serialization Tests Alexey Rybalchenko, GSI Darmstadt • 12.02.2016 motivation example topology flatbuffers messagepack performance summary Motivation ● Extend the previous serialization tests done with FairMQ with potentially more efficient approaches. ● Evaluate how can the framework make best use them, either for internal use (protocol) or user side. E.g.: preallocating data buffer (filled by user), or taking the one provided by the user. ● Evaluate their features and performance - encoding/decoding and transferring of binary blobs. 2 motivation example topology flatbuffers messagepack performance summary Examples in FairRoot (1/2) Simple topology for the digitization->reconstruction step of FairRoot Test Detector example. processor Contains data format tests for: ● boost::serialization sampler sink ● Google Protocol Buffers processor ● ROOT TMessage ● raw binary transfer (with some manual copying to create contiguous objects) Extend it for: ● MessagePack ● Google FlatBuffers 3 motivation example topology flatbuffers messagepack performance summary Examples in FairRoot (2/2) Messages: arrays of ~25-40 Digis or Hits. Digi: { 3 x int, 2 x double } Hit: { 2 x int, 8 x double } Reconstruct Hits from Digis ● Sampler sends arrays of Digis (created by digitization task). processor ● Processor uses the Digi data for (very simple) reconstruction that produces Hits. Sends arrays sampler send Digis send Hits sink of Hits ● Sink receives hits and writes them to a file in processor Root format. Reconstruct Hits from Digis ● Sink sends confirmations of received messages back to sampler for measuring the overall performance. Acknowledge each received Message 4 motivation example topology flatbuffers messagepack performance summary Google FlatBuffers Notable FlatBuffers features: Schema example: ● Access to serialized data without parsing/unpacking.
    [Show full text]
  • Package 'Msgpack'
    Package ‘msgpack’ February 22, 2018 Title A Compact, High Speed Data Format Version 1.0 Description A fast C-based encoder and streaming decoder for the 'messagepack' data format. 'Messagepack' is similar in structure to 'JSON' but uses a more compact binary encoding. Based on the CWPack C library. Depends R (>= 3.3.0) License MIT + file LICENSE Encoding UTF-8 LazyData true Suggests testthat, R.rsp VignetteBuilder R.rsp RoxygenNote 6.0.1 NeedsCompilation yes Author Peter Meilstrup [aut, cre, cph], Claes Wihlborg [ctr, cph], Björn Höhrmann [ctr, cph] Maintainer Peter Meilstrup <[email protected]> Repository CRAN Date/Publication 2018-02-22 09:15:35 UTC R topics documented: msgConnection . .2 packMsg . .4 unpackMsg . .5 Index 8 1 2 msgConnection msgConnection Read and write msgpack formatted messages over R connections. Description A msgConnection object decodes msgpack messages from an underlying R raw connection. readMsg(con) reads exactly one message from a msgConnection, or throws an error. writeMsg(x, con) writes a single message to a msgConnection. writeMsg will work with any R connection in raw mode, but reading requires a msgConnection object. Usage msgConnection(con, read_size = 2^16, max_size = NA, ...) ## S3 method for class 'msgConnection' close(con, ...) partial(con) ## S3 method for class 'msgConnection' partial(con) readMsgs(con, n = NA, ...) status(con) ## S3 method for class 'msgConnection' status(con) ## S3 method for class 'msgConnection' seek(con, rw = summary(con)$mode, ...) readMsg(con, ...) writeMsg(obj, con, ...) writeMsgs(objs, con, ...) Arguments con A connection object open in binary mode. read_size How many bytes to read at a time. max_size The largest partial message to store, in bytes.
    [Show full text]