Skip to content

Commit

Permalink
Add documentation and exports of send.multipart and receive.multipart…
Browse files Browse the repository at this point in the history
… functions
  • Loading branch information
takluyver committed Mar 24, 2014
1 parent 85340f6 commit 9145267
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 0 deletions.
2 changes: 2 additions & 0 deletions NAMESPACE
Expand Up @@ -9,6 +9,8 @@ export(zmq.version,
send.null.msg,
receive.null.msg,
receive.socket,
receive.multipart,
send.multipart,
send.raw.string,
receive.string,
receive.int,
Expand Down
13 changes: 13 additions & 0 deletions man/receive.multipart.Rd
@@ -0,0 +1,13 @@
\name{receive.multipart}
\alias{receive.multipart}
\title{Receive multipart ZMQ message}
\usage{
receive.multipart(socket)
}
\arguments{
\item{socket}{The ZMQ socket from which to receive data}
}
\description{
Returns a string vector, one element per message part.
}

16 changes: 16 additions & 0 deletions man/send.multipart.Rd
@@ -0,0 +1,16 @@
\name{send.multipart}
\alias{send.multipart}
\title{Send multipart ZMQ message.}
\usage{
send.multipart(socket, parts)
}
\arguments{
\item{socket}{The ZMQ socket on which to send data}

\item{parts}{A string vector; each element will be sent
as one part of the message}
}
\description{
Queue a string vector to be sent as a series of ZMQ message parts. Each part
before the last will be sent with the SNDMORE flag.
}

0 comments on commit 9145267

Please sign in to comment.