File: a0_b_control.Rd

package info (click to toggle)
r-cran-pbdzmq 0.3.13%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 856 kB
  • sloc: ansic: 737; sh: 93; pascal: 30; cpp: 6; makefile: 4
file content (56 lines) | stat: -rw-r--r-- 2,326 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
56
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/222_export_env.r
\docType{data}
\name{ZMQ Control Environment}
\alias{ZMQ Control Environment}
\alias{.pbd_env}
\title{Sets of controls in pbdZMQ.}
\format{
Objects contain several parameters for communicators and methods.
}
\description{
These sets of controls are used to provide default values in this package.
}
\details{
The elements of \code{.pbd_env$ZMQ.ST} are default values for socket types
as defined in `zmq.h' including \tabular{lcl}{ Elements \tab Value \tab
Usage \cr \code{PAIR} \tab 0L \tab socket type PAIR \cr \code{PUB} \tab 1L
\tab socket type PUB \cr \code{SUB} \tab 2L \tab socket type SUB \cr
\code{REQ} \tab 3L \tab socket type REQ \cr \code{REP} \tab 4L \tab socket
type REP \cr \code{DEALER} \tab 5L \tab socket type DEALER \cr \code{ROUTER}
\tab 6L \tab socket type ROUTER \cr \code{PULL} \tab 7L \tab socket type
PULL \cr \code{PUSH} \tab 8L \tab socket type PUSH \cr \code{XPUB} \tab 9L
\tab socket type XPUB \cr \code{XSUB} \tab 10L \tab socket type XSUB \cr
\code{STREAM} \tab 11L \tab socket type STREAM }

The elements of \code{.pbd_env$ZMQ.SO} are default values for socket
options as defined in `zmq.h' including 60 different values, see
\code{.pbd_env$ZMQ.SO} and `zmq.h' for details.

The elements of \code{.pbd_env$ZMQ.SR} are default values for send/recv
options as defined in `zmq.h' including \tabular{lcl}{ Elements \tab Value
\tab Usage \cr \code{BLOCK} \tab 0L \tab send/recv option BLOCK \cr
\code{DONTWAIT} \tab 1L \tab send/recv option DONTWAIT \cr \code{NOBLOCK}
\tab 1L \tab send/recv option NOBLOCK \cr \code{SNDMORE} \tab 2L \tab
send/recv option SNDMORE (not supported) }

The elements of \code{.pbd_env$ZMQ.MC} are default values for warning and
stop controls in R. These are not the ZeroMQ's internal default values. They
are defined as \tabular{lcl}{ Elements \tab Value \tab Usage \cr
\code{warning.at.error} \tab TRUE \tab if warn at error \cr
\code{stop.at.error} \tab TRUE \tab if stop at error }
}
\references{
ZeroMQ/4.1.0 API Reference:
\url{https://libzmq.readthedocs.io/en/zeromq4-1/}

Programming with Big Data in R Website: \url{https://pbdr.org/}
}
\seealso{
\code{\link{.zmqopt_init}()}.
}
\author{
Wei-Chen Chen \email{wccsnow@gmail.com}.
}
\keyword{global}
\keyword{variables}