File: a0_a_pbdZMQ-package.Rd

package info (click to toggle)
r-cran-pbdzmq 0.3.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 800 kB
  • sloc: ansic: 675; sh: 93; pascal: 30; makefile: 4
file content (55 lines) | stat: -rw-r--r-- 1,747 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/pbdZMQ-package.r
\docType{package}
\name{pbdZMQ-package}
\alias{pbdZMQ-package}
\alias{pbdZMQ}
\title{Programming with Big Data -- Interface to ZeroMQ}
\description{
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.1.0 rc1)
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.
}
\details{
\tabular{ll}{ 
  Package: \tab pbdZMQ \cr
  Type: \tab Package \cr
  License: \tab GPL-3 2.0 \cr
  LazyLoad: \tab yes \cr
}

The install command using default \pkg{pbdZMQ}'s internal ZeroMQ library is
\cr \cr 
\code{> R CMD INSTALL pbdZMQ_0.1-0.tar.gz} \cr 
\code{--configure-args="--enable-internal-zmq"} 
\cr \cr 
Other available variables include 
\tabular{ll}{
  Variable \tab Default \cr 
  \code{ZMQ_INCLUDE} \tab \code{-I./zmqsrc/include} \cr 
  \code{ZMQ_LDFLAGS} \tab \code{-L./ -lzmq} \cr
  \code{ZMQ_POLLER} \tab \code{select} \cr
} 
See the package source file \code{pbdZMQ/configure.ac} for details.

For installation using an external ZeroMQ library, see the package source
file \code{pbdZMQ/INSTALL} for details.
}
\references{
ZeroMQ/4.1.0 API Reference:
\url{http://api.zeromq.org/4-1:_start}

Programming with Big Data in R Website: \url{http://r-pbd.org/}
}
\seealso{
\code{\link{zmq.ctx.new}()}, \code{\link{zmq.socket}()}.
}
\author{
Wei-Chen Chen \email{wccsnow@gmail.com}.
}
\keyword{package}