nn_survey.adoc 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. nn_survey(7)
  2. ============
  3. NAME
  4. ----
  5. nn_survey - survey scalability protocol
  6. SYNOPSIS
  7. --------
  8. *#include <nanomsg/nn.h>*
  9. *#include <nanomsg/survey.h>*
  10. DESCRIPTION
  11. -----------
  12. Allows to broadcast a survey to multiple locations and gather the responses.
  13. Socket Types
  14. ~~~~~~~~~~~~
  15. NN_SURVEYOR::
  16. Used to send the survey. The survey is delivered to all the connected
  17. respondents. Once the query is sent, the socket can be used to receive
  18. the responses. When the survey deadline expires, receive will return
  19. ETIMEDOUT error.
  20. NN_RESPONDENT::
  21. Use to respond to the survey. Survey is received using receive function,
  22. response is sent using send function. This socket can be connected to
  23. at most one peer.
  24. Socket Options
  25. ~~~~~~~~~~~~~~
  26. NN_SURVEYOR_DEADLINE::
  27. Specifies how long to wait for responses to the survey. Once the deadline
  28. expires, receive function will return ETIMEDOUT error and all subsequent
  29. responses to the survey will be silently dropped. The deadline is measured
  30. in milliseconds. Option type is int. Default value is 1000 (1 second).
  31. SEE ALSO
  32. --------
  33. <<nn_bus#,nn_bus(7)>>
  34. <<nn_pubsub#,nn_pubsub(7)>>
  35. <<nn_reqrep#,nn_reqrep(7)>>
  36. <<nn_pipeline#,nn_pipeline(7)>>
  37. <<nn_pair#,nn_pair(7)>>
  38. <<nanomsg#,nanomsg(7)>>
  39. AUTHORS
  40. -------
  41. link:mailto:sustrik@250bpm.com[Martin Sustrik]