PageRenderTime 54ms CodeModel.GetById 29ms RepoModel.GetById 0ms app.codeStats 0ms

/man/socket.options.Rd

https://github.com/brotchie/rzmq
Unknown | 80 lines | 74 code | 6 blank | 0 comment | 0 complexity | 4ecdbffe70b7d05181a8df2dbfe32476 MD5 | raw file
  1. \name{socket.options}
  2. \alias{set.hwm}
  3. \alias{set.swap}
  4. \alias{set.affinity}
  5. \alias{set.identity}
  6. \alias{subscribe}
  7. \alias{unsubscribe}
  8. \alias{set.rate}
  9. \alias{set.recovery.ivl}
  10. \alias{set.recovery.ivl.msec}
  11. \alias{set.mcast.loop}
  12. \alias{set.sndbuf}
  13. \alias{set.rcvbuf}
  14. \alias{set.linger}
  15. \alias{set.reconnect.ivl}
  16. \alias{set.zmq.backlog}
  17. \alias{set.reconnect.ivl.max}
  18. \alias{get.rcvmore}
  19. \title{
  20. set a socket option.
  21. }
  22. \description{
  23. The zmq_setsockopt() function shall set the option specified by the
  24. option_name argument to the value pointed to by the option_value
  25. argument for the ZMQ socket pointed to by the socket argument.
  26. }
  27. \usage{
  28. set.hwm(socket, option.value)
  29. set.swap(socket, option.value)
  30. set.affinity(socket, option.value)
  31. set.identity(socket, option.value)
  32. subscribe(socket, option.value)
  33. unsubscribe(socket, option.value)
  34. set.rate(socket, option.value)
  35. set.recovery.ivl(socket, option.value)
  36. set.recovery.ivl.msec(socket, option.value)
  37. set.mcast.loop(socket, option.value)
  38. set.sndbuf(socket, option.value)
  39. set.rcvbuf(socket, option.value)
  40. set.linger(socket, option.value)
  41. set.reconnect.ivl(socket, option.value)
  42. set.zmq.backlog(socket, option.value)
  43. set.reconnect.ivl.max(socket, option.value)
  44. get.rcvmore(socket)
  45. }
  46. \arguments{
  47. \item{socket}{a zmq socket object}
  48. \item{option.value}{the new option value to bet set}
  49. }
  50. \value{
  51. a boolean indicating success or failure of the operation or in the
  52. case of getsocketoptions, the value of the requsted option.
  53. }
  54. \references{
  55. http://www.zeromq.org
  56. http://api.zeromq.org
  57. http://zguide.zeromq.org/page:all
  58. }
  59. \author{
  60. ZMQ was written by Martin Sustrik <sustrik@250bpm.com> and Martin Lucina <mato@kotelna.sk>.
  61. rzmq was written by Whit Armstrong.
  62. }
  63. \seealso{
  64. \code{\link{connect.socket},\link{bind.socket},\link{receive.socket},\link{send.socket},\link{poll.socket}}
  65. }
  66. \examples{\dontrun{
  67. library(rzmq)
  68. context = init.context()
  69. socket = init.socket(context,"ZMQ_REQ")
  70. set.hwm(socket, 1L)
  71. set.swap(socket, 100L)
  72. set.identity(socket, "big.ass.socket")
  73. }}
  74. \keyword{utilities}