pbdZMQ v0.3-1

0

Monthly downloads

0th

Percentile

Programming with Big Data -- Interface to ZeroMQ

'ZeroMQ' is a well-known library for high-performance asynchronous messaging in scalable, distributed applications. This package provides high level R wrapper functions to easily utilize 'ZeroMQ'. We mainly focus on interactive client/server programming frameworks. For convenience, a minimal 'ZeroMQ' library (4.2.2) is shipped with 'pbdZMQ', which can be used if no system installation of 'ZeroMQ' is available. A few wrapper functions compatible with 'rzmq' are also provided.

Readme

pbdZMQ

  • License: License
  • Download: Download
  • Status: Build Status Appveyor Build status
  • Author: See section below.

pbdZMQ is an R package providing a simplified interface to ZeroMQ with a focus on client/server programming frameworks. Notably, pbdZMQ should allow for the use of ZeroMQ on Windows platforms.

Interfaces

The package contains 2 separate interfaces:

  1. One modeled after the ZeroMQ C interface (see help("czmq"))
  2. One modeled after the rzmq interface (see help("rzmq"))

Client/Server Example

The primary focus of pbdZMQ is for building client/server interfaces for R. An example of this can be found in the pbdCS package, which uses this model to control batch MPI servers interactively. There are also several illustrative examples in the pbdZMQ package vignette.

The basic idea is that you need a server R process, and a separate client R process. For demonstration/simplicity, assume they are both running on the same machine. The server we describe here is very basic. You can see a more detailed example in the pbdZMQ package vignette.

Server

Save the following as, say, server.r and run it in batch by running Rscript server.r from a terminal.

library(pbdZMQ)
ctxt <- init.context()
socket <- init.socket(ctxt, "ZMQ_REP")
bind.socket(socket, "tcp://*:55555")


cat("Client command:  ")
  msg <- receive.socket(socket)

cat(msg, "\n")
send.socket(socket, "Message received!")

Client

From an interactive R session (not in batch), enter the following:

library(pbdZMQ)
ctxt <- init.context()
socket <- init.socket(ctxt, "ZMQ_REQ")
connect.socket(socket, "tcp://localhost:55555")

send.socket(socket, "1+1")
receive.socket(socket)

If all goes well, your message should be sent from the client to the server, before your server terminates.

For an example of how to do this more persistently, see the pbdZMQ package vignette.

Installation

pbdZMQ requires

  • R version 3.0.0 or higher.
  • Linux, Mac OSX, Windows, or FreeBSD.
  • libzmq >= 4.0.4.
  • Solaris 10 requiring external libzmq 4.0.7 and OpenCSW.

A distribution of libzmq is shipped with pbdZMQ for convenience. However, if you already have a system installation of ZeroMQ, then it is simple to use that with pbdZMQ. Full details on installation and troubleshooting can be found in the package vignette, located at inst/doc/pbdMPI-guide.pdf of the pbdZMQ source tree.

The package can be installed from the CRAN via the usual install.packages("pbdZMQ"), or via the devtools package:

library(devtools)
install_github("RBigData/pbdZMQ")

Citation

When mentioning the pbdZMQ, please cite:

@MISC{pbdZMQ2015,
  author = {Chen, W.-C. and Schmidt, D. and Heckendorf, C. and Ostrouchov, G.},
  title = {pbdZMQ: Programming with Big Data -- Interface to ZeroMQ},
  year = {2015},
  note = {R Package, URL https://cran.r-project.org/package=pbdZMQ}
}

Authors

pbdMPI is authored and maintained by:

  • Wei-Chen Chen
  • Drew Schmidt
  • Christian Heckendorf
  • George Ostrouchov

With additional contributions from:

  • Whit Armstrong (some functions are modified from rzmq for backwards compatibility)
  • Brian Ripley (C code of shellexec)
  • The R Core team (some functions are modified from the R source code)
  • Elliott Sales de Andrade (sprintf version underflow)
  • Spencer Aiello (windows conf spacing)

For the distribution of ZeroMQ that is shipped with pbdZMQ, you can find details of authorship and copyright in inst/zmq_copyright/ of the pbdZMQ source tree, or under zmq_copyright/ of a binary installation of pbdZMQ.

Functions in pbdZMQ

Name Description
pbdZMQ-package Programming with Big Data -- Interface to ZeroMQ
ZMQ Control Environment Sets of controls in pbdZMQ.
Set Control Functions Set controls in pbdZMQ
Initial Control Functions Initial controls in pbdZMQ
Wrapper Functions for rzmq All Wrapper Functions for rzmq
Utility Functions Utility Functions
C-like Wrapper Functions for ZeroMQ The C-like ZeroMQ Interface
ls A wrapper function for base::ls
Send Receive Functions Send Receive Functions
File Transfer Functions File Transfer Functions
ZMQ Control Functions Sets of controls in pbdZMQ.
ZMQ Flags ZMQ Flags
Message Function Message Functions
address Form an Address/Endpoint
random_port Random Port
shellexec.wcc Shell Execution via cmd windows
Context Functions Context Functions
Socket Functions Socket Functions
Send Receive Multiple Raw Buffers Send Receive Multiple Raw Buffers
Poll Functions Poll Functions
No Results!

Vignettes of pbdZMQ

Name
pbdZMQ-include/00-preamble.tex
pbdZMQ-include/01-acknowledgement.tex
pbdZMQ-include/01-copyright.tex
pbdZMQ-include/01-introduction.tex
pbdZMQ-include/02-installation.tex
pbdZMQ-include/03-example.tex
pbdZMQ-include/04-backward.tex
pbdZMQ-include/05-cs.tex
pbdZMQ-include/06-solaris.tex
pbdZMQ-include/99-faq.tex
pbdZMQ-include/my_jss.cls
pbdZMQ-include/pbdZMQ.bib
build_pdf.sh
pbdZMQ-guide.Rnw
No Results!

Last month downloads

Details

Date 2018-01-05
LazyLoad yes
LazyData yes
Copyright See files AUTHORS, COPYING, COPYING.LESSER, and MAINTAINERS in 'pbdZMQ/inst/zmq_copyright/' for the ZeroMQ source files in 'src/zmq_src/' which are under GPL-3.
SystemRequirements Linux, Mac OSX, and Windows, or 'ZeroMQ' library >= 4.0.4. Solaris 10 needs 'ZeroMQ' library 4.0.7 and 'OpenCSW'.
License GPL-3
URL http://r-pbd.org/
BugReports http://group.r-pbd.org/
MailingList Please send questions and comments regarding pbdR to RBigData@gmail.com
NeedsCompilation yes
RoxygenNote 6.0.1
Packaged 2018-01-07 20:17:11 UTC; snoweye
Repository CRAN
Date/Publication 2018-01-11 10:06:11 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/pbdZMQ)](http://www.rdocumentation.org/packages/pbdZMQ)