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 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rzmq_wrapper.r
\name{Wrapper Functions for rzmq}
\alias{Wrapper Functions for rzmq}
\alias{send.socket}
\alias{receive.socket}
\alias{init.context}
\alias{init.socket}
\alias{bind.socket}
\alias{connect.socket}
\title{All Wrapper Functions for rzmq}
\usage{
send.socket(socket, data, send.more = FALSE, serialize = TRUE)
receive.socket(socket, unserialize = TRUE, dont.wait = FALSE)
init.context()
init.socket(context, socket.type)
bind.socket(socket, address)
connect.socket(socket, address)
}
\arguments{
\item{socket}{A ZMQ socket.}
\item{data}{An R object.}
\item{send.more}{Logical; will more messages be sent?}
\item{serialize, unserialize}{Logical; determines if serialize/unserialize should be called
on the sent/received data.}
\item{dont.wait}{Logical; determines if reception is blocking.}
\item{context}{A ZMQ context.}
\item{socket.type}{The type of ZMQ socket as a string, of the form "ZMQ_type". Valid 'type'
values are PAIR, PUB, SUB, REQ, REP, DEALER, PULL, PUSH, XPUB, XSUB, and
STERAM.}
\item{address}{A valid address. See details.}
}
\description{
Wrapper functions for backwards compatibility with rzmq. See vignette
for examples.
}
\details{
\code{send.socket()}/\code{receive.socket()} send/receive messages over
a socket. These are simple wrappers around \code{zmq.msg.send()} and
\code{zmq.msg.receive()}, respectively.
\code{init.context()} creates a new ZeroMQ context. A useful wrapper
around \code{zmq.ctx.new()} which handles freeing memory for you, i.e.
\code{zmq.ctx.destroy()} will automatically be called for you.
\code{init.socket()} creates a ZeroMQ socket; serves as a high-level
binding for \code{zmq.socket()}, including handling freeing memory
automatically. See also \code{.pbd_env$ZMQ.ST}.
\code{bind.socket()}: see \code{zmq.bind()}.
\code{connect.socket()}: see \code{zmq.connect()}
}
\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/}
}
\author{
Wei-Chen Chen \email{wccsnow@gmail.com}.
}
\keyword{rzmq}
|