ceph/src/Beast/doc/types/Body.qbk

   1 [/
   2     Copyright (c) 2013-2017 Vinnie Falco (vinnie dot falco at gmail 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:Body Body requirements]
   9
  10 A [*Body] type is supplied as a template argument to the __message__ class. It
  11 controls both the type of the data member of the resulting message object, and
  12 the algorithms used during parsing and serialization.
  13
  14 In this table:
  15
  16 * `X` is a type meeting the requirements of [*`Body`].
  17
  18 [table Body requirements
  19 [[operation] [type] [semantics, pre/post-conditions]]
  20 [
  21     [`X::value_type`]
  22     []
  23     [
  24         The type of the `message::body` member.
  25         If this is not movable or not copyable, the containing message
  26         will be not movable or not copyable.
  27     ]
  28 ]
  29 [
  30     [`X::reader`]
  31     []
  32     [
  33         If present, a type meeting the requirements of
  34         [link beast.ref.Reader [*`Reader`]].
  35         Provides an implementation to parse the body.
  36     ]
  37 ]
  38 [
  39     [`X::writer`]
  40     []
  41     [
  42         If present, a type meeting the requirements of
  43         [link beast.ref.Writer [*`Writer`]].
  44         Provides an implementation to serialize the body.
  45     ]
  46 ]
  47 ]
  48
  49 [endsect]