ceph/src/boost/libs/asio/doc/requirements/SettableSocketOption.qbk

   1 [/
   2  / Copyright (c) 2003-2016 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
   8 [section:SettableSocketOption Settable socket option requirements]
   9
  10 In the table below, `X` denotes a socket option class, `a` denotes a value of
  11 `X`, `p` denotes a value that meets the [link boost_asio.reference.Protocol
  12 protocol] requirements, and `u` denotes an identifier.
  13
  14 [table SettableSocketOption requirements
  15   [[expression] [type] [assertion/note\npre/post-conditions]]
  16   [
  17     [`a.level(p);`]
  18     [`int`]
  19     [
  20       Returns a value suitable for passing as the /level/ argument to __POSIX__
  21       __setsockopt__ (or equivalent).
  22     ]
  23   ]
  24   [
  25     [`a.name(p);`]
  26     [`int`]
  27     [
  28       Returns a value suitable for passing as the /option_name/ argument to
  29       __POSIX__ __setsockopt__ (or equivalent).
  30     ]
  31   ]
  32   [
  33     [`const X& u = a;
  34       u.data(p);`]
  35     [a pointer, convertible to `const void*`]
  36     [
  37       Returns a pointer suitable for passing as the /option_value/ argument to
  38       __POSIX__ __setsockopt__ (or equivalent).
  39     ]
  40   ]
  41   [
  42     [`a.size(p);`]
  43     [`size_t`]
  44     [
  45       Returns a value suitable for passing as the /option_len/ argument to
  46       __POSIX__ __setsockopt__ (or equivalent), after appropriate integer
  47       conversion has been performed.
  48     ]
  49   ]
  50 ]
  51
  52 [endsect]