/Src/Dependencies/Boost/libs/asio/doc/requirements/SettableSocketOption.qbk

http://hadesmem.googlecode.com/ · text · 52 lines · 48 code · 4 blank · 0 comment · 0 complexity · a4df269641a488774e49276ccd909151 MD5 · raw file

  1. [/
  2. / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
  3. /
  4. / Distributed under the Boost Software License, Version 1.0. (See accompanying
  5. / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  6. /]
  7. [section:SettableSocketOption Settable socket option requirements]
  8. In the table below, `X` denotes a socket option class, `a` denotes a value of
  9. `X`, `p` denotes a value that meets the [link boost_asio.reference.Protocol
  10. protocol] requirements, and `u` denotes an identifier.
  11. [table SettableSocketOption requirements
  12. [[expression] [type] [assertion/note\npre/post-conditions]]
  13. [
  14. [`a.level(p);`]
  15. [`int`]
  16. [
  17. Returns a value suitable for passing as the /level/ argument to __POSIX__
  18. __setsockopt__ (or equivalent).
  19. ]
  20. ]
  21. [
  22. [`a.name(p);`]
  23. [`int`]
  24. [
  25. Returns a value suitable for passing as the /option_name/ argument to
  26. __POSIX__ __setsockopt__ (or equivalent).
  27. ]
  28. ]
  29. [
  30. [`const X& u = a;
  31. u.data(p);`]
  32. [a pointer, convertible to `const void*`]
  33. [
  34. Returns a pointer suitable for passing as the /option_value/ argument to
  35. __POSIX__ __setsockopt__ (or equivalent).
  36. ]
  37. ]
  38. [
  39. [`a.size(p);`]
  40. [`size_t`]
  41. [
  42. Returns a value suitable for passing as the /option_len/ argument to
  43. __POSIX__ __setsockopt__ (or equivalent), after appropriate integer
  44. conversion has been performed.
  45. ]
  46. ]
  47. ]
  48. [endsect]