bdlb_bigendian.h

Go to the documentation of this file.

/// @file bdlb_bigendian.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// bdlb_bigendian.h                                                   -*-C++-*-
#ifndef INCLUDED_BDLB_BIGENDIAN
#define INCLUDED_BDLB_BIGENDIAN
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup bdlb_bigendian bdlb_bigendian
/// @brief  Provide big-endian integer types.
/// @addtogroup bdl
/// @{
/// @addtogroup bdlb
/// @{
/// @addtogroup bdlb_bigendian
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#bdlb_bigendian-purpose"> Purpose</a>
/// * <a href="#bdlb_bigendian-classes"> Classes </a>
/// * <a href="#bdlb_bigendian-description"> Description </a>
///   * <a href="#bdlb_bigendian-usage"> Usage </a>
///     * <a href="#bdlb_bigendian-example-1-basic-use-of-bdlb-bigendian">  Example 1: Basic Use of bdlb::BigEndian </a>
///
/// # Purpose {#bdlb_bigendian-purpose}
/// Provide big-endian integer types.
///
/// # Classes {#bdlb_bigendian-classes}
///
/// -  bdlb::BigEndianInt16:  signed 16-bit in-core big-endian integer
/// -  bdlb::BigEndianUint16: unsigned 16-bit in-core big-endian integer
/// -  bdlb::BigEndianInt32:  signed 32-bit in-core big-endian integer
/// -  bdlb::BigEndianUint32: unsigned 32-bit in-core big-endian integer
/// -  bdlb::BigEndianInt64:  signed 64-bit in-core big-endian integer
/// -  bdlb::BigEndianUint64: unsigned 64-bit in-core big-endian integer
///
/// @see  bsls_types
///
/// # Description {#bdlb_bigendian-description}
/// This component provides generic in-core big-endian integer
/// types `bdlb::BigEndianInt16`, `bdlb::BigEndianUint16`,
/// `bdlb::BigEndianInt32`, `bdlb::BigEndianUint32`, `bdlb::BigEndianInt64` and
/// `bdlb::BigEndianUint64` that store integral values that they represent in a
/// big-endian byte order.  For example, an integer value 0x01020304 will be
/// internally stored by the `bdlb::BigEndianInt32` object as 0x04030201 on
/// little-endian platforms.
///
/// ## Usage {#bdlb_bigendian-usage}
///
///
/// This section illustrates intended use of this component.
///
/// ###  Example 1: Basic Use of bdlb::BigEndian {#bdlb_bigendian-example-1-basic-use-of-bdlb-bigendian}
///
///
/// This example demonstrates using `bdlb::BigEndian` types to represent a
/// structure meant to be exchanged over the network ( which historically uses
/// big-endian byte order ) or stored in-core as big-endian integers.  First, we
/// define the structure:
/// @code
/// /// This structure represents the header of the protocol.  All integer
/// /// values are stored in the network byte-order (i.e., big-endian).
/// struct ProtocolHeader {
///
///     bdlb::BigEndianUint16 d_protocolVersion;
///     bdlb::BigEndianUint16 d_messageType;
///     bdlb::BigEndianUint32 d_messageLength;
/// };
/// @endcode
/// Next, we prepare in-memory representation of the protocol header with
/// protocol version set to `0x1`, message type set to `0x02` and message length
/// set to `0x1234` in the big-endian byte order (most significant bytes
/// first):
/// @code
/// const char buffer[8] = { 0x00, 0x01, 0x00, 0x02, 0x00, 0x00, 0x12, 0x34 };
/// @endcode
/// Now, we create an instance of the `ProtocolHeader` structure and emulate
/// packet reception over the network:
/// @code
/// struct ProtocolHeader header;
/// assert(8 == sizeof(header));
/// memcpy(static_cast<void*>(&header), buffer, 8);
/// @endcode
/// Next, we verify that actual in-core values depend on the endianess of the
/// underlying platform:
/// @code
/// #ifdef BSLS_PLATFORM_IS_LITTLE_ENDIAN
/// assert(0x0100 ==
///        static_cast<short>(*(reinterpret_cast<unsigned short*>(
///                                              &header.d_protocolVersion))));
///
/// assert(0x0200 ==
///        static_cast<short>(*(reinterpret_cast<unsigned short*>(
///                                              &header.d_messageType))));
///
/// assert(0x34120000 == *(reinterpret_cast<unsigned int*>(
///                                              &header.d_messageLength)));
/// #endif // BSLS_PLATFORM_IS_LITTLE_ENDIAN
///
/// #ifdef BSLS_PLATFORM_IS_BIG_ENDIAN
/// assert(0x01 ==
///        static_cast<short>(*(reinterpret_cast<unsigned short*>(
///                                              &header.d_protocolVersion))));
///
/// assert(0x02 ==
///        static_cast<short>(*(reinterpret_cast<unsigned short*>(
///                                              &header.d_messageType))));
///
/// assert(0x1234 == *(reinterpret_cast<unsigned int*>(
///                                              &header.d_messageLength)));
/// #endif // BSLS_PLATFORM_IS_BIG_ENDIAN
/// @endcode
/// Finally, we verify that the received protocol header can be validated on
/// platforms of any endianess:
/// @code
/// assert(0x01   == header.d_protocolVersion);
/// assert(0x02   == header.d_messageType);
/// assert(0x1234 == header.d_messageLength);
/// @endcode
/// @}
/** @} */
/** @} */
 
/** @addtogroup bdl
 * @{
 */
/** @addtogroup bdlb
 * @{
 */
/** @addtogroup bdlb_bigendian
 * @{
 */
 
#include <bdlscm_version.h>
 
#include <bdlb_printmethods.h> // 'bdlb::HasPrintMethod'
 
#include <bslmf_istriviallycopyable.h>
#include <bslmf_nestedtraitdeclaration.h>
 
#include <bsls_byteorder.h>
#include <bsls_platform.h>
#include <bsls_types.h>
 
#include <bsl_iosfwd.h>
 
 
namespace bdlb {
 
                         // ====================
                         // class BigEndianInt16
                         // ====================
 
/// This class provides a container for an in-core representation of a
/// signed 16-bit big-endian integer.  It supports a complete set of *value*
/// *semantic* operations, including copy construction, assignment, equality
/// comparison, `bsl::ostream` printing, and BDEX serialization.  
/// 
/// \note Note that   the copy constructor and copy-assignment operator are provided by the
/// compiler.  Any object of this class can be converted to a `short`
/// allowing comparison with any other object of this class.  This class is
/// *exception* *neutral* with no guarantee of rollback: if an exception is
/// thrown during the invocation of a method on a pre-existing object, the
/// object is left in a valid state, but its value is undefined.  In no
/// event is memory leaked.  Finally, *aliasing* (e.g., using all or part of
/// an object as both source and destination) is supported in all cases.
///
/// See @ref bdlb_bigendian 
class BigEndianInt16 {
 
    // DATA
    short d_value;  // in-core value (network byte-order)
 
    // FRIENDS
    friend bool operator==(const BigEndianInt16& lhs,
                           const BigEndianInt16& rhs);
    friend bool operator!=(const BigEndianInt16& lhs,
                           const BigEndianInt16& rhs);
 
  public:
    // TRAITS
    BSLMF_NESTED_TRAIT_DECLARATION(BigEndianInt16, bsl::is_trivially_copyable);
    BSLMF_NESTED_TRAIT_DECLARATION(BigEndianInt16, bdlb::HasPrintMethod);
 
    // CLASS METHODS
 
    /// Create and initialize a `BigEndianInt16` object that stores the
    /// specified `value` as a signed 16-bit big-endian integer.
    static BigEndianInt16 make(short value);
 
#ifndef BDE_OMIT_INTERNAL_DEPRECATED  // BDE2.22
 
    /// Return the most current BDEX streaming version number supported by
    /// this class.  See the `bslx` package-level documentation for more
    /// information on BDEX streaming of value-semantic types and
    /// containers.
    static int maxSupportedBdexVersion();
#endif  // BDE_OMIT_INTERNAL_DEPRECATED  -- BDE2.22
 
    /// Return the maximum valid BDEX format version, as indicated by the
    /// specified `versionSelector`, to be passed to the `bdexStreamOut` method.  
    /// 
    /// \note Note that   the `versionSelector` is expected to be formatted
    /// as `yyyymmdd`, a date representation.  See the `bslx` package-level
    /// documentation for more information on BDEX streaming of
    /// value-semantic types and containers.
    static int maxSupportedBdexVersion(int versionSelector);
 
    // CREATORS
     BigEndianInt16() = default;
     BigEndianInt16(const BigEndianInt16& other) = default;
     ~BigEndianInt16() = default;
 
    // MANIPULATORS
     BigEndianInt16& operator=(const BigEndianInt16& other) = default;
 
    /// Store in this object the specified `value` as a signed 16-bit
    /// big-endian integer, and return a reference to this modifiable
    /// object.
    BigEndianInt16& operator=(short value);
 
    /// Assign to this object the value read from the specified input
    /// `stream` using the specified `version` format, and return a
    /// reference to `stream`.  If `stream` is initially invalid, this
    /// operation has no effect.  If `version` is not supported, this object
    /// is unaltered and `stream` is invalidated but otherwise unmodified.
    /// If `version` is supported but `stream` becomes invalid during this
    /// operation, this object has an undefined, but valid, state.  
    /// 
    /// \note Note that   no version is read from `stream`.  See the `bslx` package-level
    /// documentation for more information on BDEX streaming of
    /// value-semantic types and containers.
    template <class STREAM>
    STREAM& bdexStreamIn(STREAM& stream, int version);
 
    // ACCESSORS
 
    /// Return the value stored in this object as a `short` in the native
    /// byte-order.
    operator short() const;
 
    /// Format this object to the specified output `stream` at the (absolute
    /// value of) the optionally specified indentation `level` and return a
    /// reference to `stream`.  If `level` is specified, optionally specify
    /// `spacesPerLevel`, the number of spaces per indentation level for
    /// this and all of its nested objects.  If `level` is negative,
    /// suppress indentation of the first line.  If `spacesPerLevel` is
    /// negative, format the entire output on one line, suppressing all but
    /// the initial indentation (as governed by `level`).  If `stream` is
    /// not valid on entry, this operation has no effect.
    bsl::ostream& print(bsl::ostream& stream,
                        int           level = 0,
                        int           spacesPerLevel = 4) const;
 
    /// Write this value to the specified output `stream` using the
    /// specified `version` format, and return a reference to `stream`.  If
    /// `stream` is initially invalid, this operation has no effect.  If
    /// `version` is not supported, `stream` is invalidated but otherwise unmodified.  
    /// 
    /// \note Note that   `version` is not written to `stream`.  See
    /// the `bslx` package-level documentation for more information on BDEX
    /// streaming of value-semantic types and containers.
    template <class STREAM>
    STREAM& bdexStreamOut(STREAM& stream, int version) const;
};
 
// FREE OPERATORS
 
/// Return `true` if the specified `lhs` and `rhs` `BigEndianInt16` objects
/// have the same value, and `false` otherwise.  Two `BigEndianInt16`
/// objects have the same value if and only if the respective integral
/// network byte-order values that they represent have the same value.
bool operator==(const BigEndianInt16& lhs, const BigEndianInt16& rhs);
 
/// Return `true` if the specified `lhs` and `rhs` `BigEndianInt16` objects
/// do not have the same value, and `false` otherwise.  Two `BigEndianInt16`
/// objects do not have the same value if and only if the respective
/// integral network byte-order values that they represent do not have the
/// same value.
bool operator!=(const BigEndianInt16& lhs, const BigEndianInt16& rhs);
 
/// Write the specified `integer` to the specified output `stream` and
/// return a reference to the modifiable `stream`.
bsl::ostream& operator<<(bsl::ostream&         stream,
                         const BigEndianInt16& integer);
 
/// Invoke the specified `hashAlgorithm` on the attributes of the specified
/// `object`.
template <class HASH_ALGORITHM>
void hashAppend(HASH_ALGORITHM& hashAlgorithm, const BigEndianInt16& object);
 
                         // =====================
                         // class BigEndianUint16
                         // =====================
 
/// This class provides a container for an in-core representation of an
/// unsigned 16-bit big-endian integer.  It supports a complete set of
/// *value* *semantic* operations, including copy construction, assignment,
/// equality comparison, `bsl::ostream` printing, and BDEX serialization. 
/// 
/// \note Note that   the copy constructor and copy-assignment operator are provided
/// by the compiler.  Any object of this class can be converted to an
/// `unsigned short` allowing comparison with any other object of this
/// class.  This class is *exception* *neutral* with no guarantee of
/// rollback: if an exception is thrown during the invocation of a method on
/// a pre-existing object, the object is left in a valid state, but its
/// value is undefined.  In no event is memory leaked.  Finally, *aliasing*
/// (e.g., using all or part of an object as both source and destination) is
/// supported in all cases.
///
/// See @ref bdlb_bigendian 
class BigEndianUint16 {
 
    // DATA
    unsigned short d_value;  // in-core value (network byte-order)
 
    // FRIENDS
    friend bool operator==(const BigEndianUint16& lhs,
                           const BigEndianUint16& rhs);
    friend bool operator!=(const BigEndianUint16& lhs,
                           const BigEndianUint16& rhs);
 
  public:
    // TRAITS
    BSLMF_NESTED_TRAIT_DECLARATION(BigEndianUint16,
                                   bsl::is_trivially_copyable);
    BSLMF_NESTED_TRAIT_DECLARATION(BigEndianUint16, bdlb::HasPrintMethod);
 
    // CLASS METHODS
 
    /// Create and initialize a `BigEndianUint16` object that stores the
    /// specified `value` as a unsigned 16-bit big-endian integer.
    static BigEndianUint16 make(unsigned short value);
 
#ifndef BDE_OMIT_INTERNAL_DEPRECATED  // BDE2.22
 
    /// Return the most current BDEX streaming version number supported by
    /// this class.  See the `bslx` package-level documentation for more
    /// information on BDEX streaming of value-semantic types and
    /// containers.
    static int maxSupportedBdexVersion();
#endif  // BDE_OMIT_INTERNAL_DEPRECATED  -- BDE2.22
 
    /// Return the maximum valid BDEX format version, as indicated by the
    /// specified `versionSelector`, to be passed to the `bdexStreamOut` method.  
    /// 
    /// \note Note that   the `versionSelector` is expected to be formatted
    /// as `yyyymmdd`, a date representation.  See the `bslx` package-level
    /// documentation for more information on BDEX streaming of
    /// value-semantic types and containers.
    static int maxSupportedBdexVersion(int versionSelector);
 
    // CREATORS
     BigEndianUint16() = default;
     BigEndianUint16(const BigEndianUint16& other) = default;
     ~BigEndianUint16() = default;
 
    // MANIPULATORS
     BigEndianUint16& operator=(const BigEndianUint16& other) = default;
 
    /// Store in this object the specified `value` as an unsigned 16-bit
    /// big-endian integer, and return a reference to this modifiable
    /// object.
    BigEndianUint16& operator=(unsigned short value);
 
    /// Assign to this object the value read from the specified input
    /// `stream` using the specified `version` format, and return a
    /// reference to `stream`.  If `stream` is initially invalid, this
    /// operation has no effect.  If `version` is not supported, this object
    /// is unaltered and `stream` is invalidated but otherwise unmodified.
    /// If `version` is supported but `stream` becomes invalid during this
    /// operation, this object has an undefined, but valid, state.  
    /// 
    /// \note Note that   no version is read from `stream`.  See the `bslx` package-level
    /// documentation for more information on BDEX streaming of
    /// value-semantic types and containers.
    template <class STREAM>
    STREAM& bdexStreamIn(STREAM& stream, int version);
 
    // ACCESSORS
 
    /// Return the value stored in this object as a `unsigned short` in the
    /// native byte-order.
    operator unsigned short() const;
 
    /// Format this object to the specified output `stream` at the (absolute
    /// value of) the optionally specified indentation `level` and return a
    /// reference to `stream`.  If `level` is specified, optionally specify
    /// `spacesPerLevel`, the number of spaces per indentation level for
    /// this and all of its nested objects.  If `level` is negative,
    /// suppress indentation of the first line.  If `spacesPerLevel` is
    /// negative, format the entire output on one line, suppressing all but
    /// the initial indentation (as governed by `level`).  If `stream` is
    /// not valid on entry, this operation has no effect.
    bsl::ostream& print(bsl::ostream& stream,
                        int           level = 0,
                        int           spacesPerLevel = 4) const;
 
    /// Write this value to the specified output `stream` using the
    /// specified `version` format, and return a reference to `stream`.  If
    /// `stream` is initially invalid, this operation has no effect.  If
    /// `version` is not supported, `stream` is invalidated but otherwise unmodified.  
    /// 
    /// \note Note that   `version` is not written to `stream`.  See
    /// the `bslx` package-level documentation for more information on BDEX
    /// streaming of value-semantic types and containers.
    template <class STREAM>
    STREAM& bdexStreamOut(STREAM& stream, int version) const;
};
 
// FREE OPERATORS
 
/// Return `true` if the specified `lhs` and `rhs` `BigEndianUint16` objects
/// have the same value, and `false` otherwise.  Two `BigEndianUint16`
/// objects have the same value if and only if the respective integral
/// network byte-order values that they represent have the same value.
bool operator==(const BigEndianUint16& lhs, const BigEndianUint16& rhs);
 
/// Return `true` if the specified `lhs` and `rhs` `BigEndianUint16` objects
/// do not have the same value, and `false` otherwise.  Two
/// `BigEndianUint16` objects do not have the same value if and only if the
/// respective integral network byte-order values that they represent do not
/// have the same value.
bool operator!=(const BigEndianUint16& lhs, const BigEndianUint16& rhs);
 
/// Write the specified `integer` to the specified output `stream`, and
/// return a reference to the modifiable `stream`.
bsl::ostream& operator<<(bsl::ostream&          stream,
                         const BigEndianUint16& integer);
 
/// Invoke the specified `hashAlgorithm` on the attributes of the specified
/// `object`.
template <class HASH_ALGORITHM>
void hashAppend(HASH_ALGORITHM& hashAlgorithm, const BigEndianUint16& object);
 
                         // ====================
                         // class BigEndianInt32
                         // ====================
 
/// This class provides a container for an in-core representation of a
/// signed 32-bit big-endian integer.  It supports a complete set of *value*
/// *semantic* operations, including copy construction, assignment, equality
/// comparison, `bsl::ostream` printing, and BDEX serialization.  
/// 
/// \note Note that   the copy constructor and copy-assignment operator are provided by the
/// compiler.  Any object of this class can be converted to an `int`
/// allowing comparison with any other object of this class.  This class is
/// *exception* *neutral* with no guarantee of rollback: if an exception is
/// thrown during the invocation of a method on a pre-existing object, the
/// object is left in a valid state, but its value is undefined.  In no
/// event is memory leaked.  Finally, *aliasing* (e.g., using all or part of
/// an object as both source and destination) is supported in all cases.
///
/// See @ref bdlb_bigendian 
class BigEndianInt32 {
 
    // DATA
    int d_value;  // in-core value (network byte-order)
 
    // FRIENDS
    friend bool operator==(const BigEndianInt32& lhs,
                           const BigEndianInt32& rhs);
    friend bool operator!=(const BigEndianInt32& lhs,
                           const BigEndianInt32& rhs);
 
  public:
    // TRAITS
    BSLMF_NESTED_TRAIT_DECLARATION(BigEndianInt32, bsl::is_trivially_copyable);
    BSLMF_NESTED_TRAIT_DECLARATION(BigEndianInt32, bdlb::HasPrintMethod);
 
    // CLASS METHODS
 
    /// Create and initialize a `BigEndianInt32` object that stores the
    /// specified `value` as a signed 32-bit big-endian integer.
    static BigEndianInt32 make(int value);
 
#ifndef BDE_OMIT_INTERNAL_DEPRECATED
    /// Return the most current BDEX streaming version number supported by
    /// this class.  See the `bslx` package-level documentation for more
    /// information on BDEX streaming of value-semantic types and
    /// containers.
    static int maxSupportedBdexVersion();
#endif  // BDE_OMIT_INTERNAL_DEPRECATED
 
    /// Return the maximum valid BDEX format version, as indicated by the
    /// specified `versionSelector`, to be passed to the `bdexStreamOut` method.  
    /// 
    /// \note Note that   the `versionSelector` is expected to be formatted
    /// as `yyyymmdd`, a date representation.  See the `bslx` package-level
    /// documentation for more information on BDEX streaming of
    /// value-semantic types and containers.
    static int maxSupportedBdexVersion(int versionSelector);
 
    // CREATORS
     BigEndianInt32() = default;
     BigEndianInt32(const BigEndianInt32& other) = default;
     ~BigEndianInt32() = default;
 
    // MANIPULATORS
     BigEndianInt32& operator=(const BigEndianInt32& other) = default;
 
    /// Store in this object the specified `value` as a signed 32-bit
    /// big-endian integer, and return a reference to this modifiable
    /// object.
    BigEndianInt32& operator=(int value);
 
    /// Assign to this object the value read from the specified input
    /// `stream` using the specified `version` format, and return a
    /// reference to `stream`.  If `stream` is initially invalid, this
    /// operation has no effect.  If `version` is not supported, this object
    /// is unaltered and `stream` is invalidated but otherwise unmodified.
    /// If `version` is supported but `stream` becomes invalid during this
    /// operation, this object has an undefined, but valid, state.  
    /// 
    /// \note Note that   no version is read from `stream`.  See the `bslx` package-level
    /// documentation for more information on BDEX streaming of
    /// value-semantic types and containers.
    template <class STREAM>
    STREAM& bdexStreamIn(STREAM& stream, int version);
 
    // ACCESSORS
 
    /// Return the value stored in this object as a `int` in the native
    /// byte-order.
    operator int() const;
 
    /// Format this object to the specified output `stream` at the (absolute
    /// value of) the optionally specified indentation `level` and return a
    /// reference to `stream`.  If `level` is specified, optionally specify
    /// `spacesPerLevel`, the number of spaces per indentation level for
    /// this and all of its nested objects.  If `level` is negative,
    /// suppress indentation of the first line.  If `spacesPerLevel` is
    /// negative, format the entire output on one line, suppressing all but
    /// the initial indentation (as governed by `level`).  If `stream` is
    /// not valid on entry, this operation has no effect.
    bsl::ostream& print(bsl::ostream& stream,
                        int           level = 0,
                        int           spacesPerLevel = 4) const;
 
    /// Write this value to the specified output `stream` using the
    /// specified `version` format, and return a reference to `stream`.  If
    /// `stream` is initially invalid, this operation has no effect.  If
    /// `version` is not supported, `stream` is invalidated but otherwise unmodified.  
    /// 
    /// \note Note that   `version` is not written to `stream`.  See
    /// the `bslx` package-level documentation for more information on BDEX
    /// streaming of value-semantic types and containers.
    template <class STREAM>
    STREAM& bdexStreamOut(STREAM& stream, int version) const;
};
 
// FREE OPERATORS
 
/// Return `true` if the specified `lhs` and `rhs` `BigEndianInt32` objects
/// have the same value, and `false` otherwise.  Two `BigEndianInt32`
/// objects have the same value if and only if the respective integral
/// network byte-order values that they represent have the same value.
bool operator==(const BigEndianInt32& lhs, const BigEndianInt32& rhs);
 
/// Return `true` if the specified `lhs` and `rhs` `BigEndianInt32` objects
/// do not have the same value, and `false` otherwise.  Two `BigEndianInt32`
/// objects do not have the same value if and only if the respective
/// integral network byte-order values that they represent do not have the
/// same value.
bool operator!=(const BigEndianInt32& lhs, const BigEndianInt32& rhs);
 
/// Write the specified `integer` to the specified output `stream`, and
/// return a reference to the modifiable `stream`.
bsl::ostream& operator<<(bsl::ostream&         stream,
                         const BigEndianInt32& integer);
 
/// Invoke the specified `hashAlgorithm` on the attributes of the specified
/// `object`.
template <class HASH_ALGORITHM>
void hashAppend(HASH_ALGORITHM& hashAlgorithm, const BigEndianInt32& object);
 
                         // =====================
                         // class BigEndianUint32
                         // =====================
 
/// This class provides a container for an in-core representation of an
/// unsigned 32-bit big-endian integer.  It supports a complete set of
/// *value* *semantic* operations, including copy construction, assignment,
/// equality comparison, `bsl::ostream` printing, and BDEX serialization. 
/// 
/// \note Note that   the copy constructor and copy-assignment operator are provided
/// by the compiler.  Any object of this class can be converted to an
/// `unsigned int` allowing comparison with any other object of this class.
/// This class is *exception* *neutral* with no guarantee of rollback: if an
/// exception is thrown during the invocation of a method on a pre-existing
/// object, the object is left in a valid state, but its value is undefined.
/// In no event is memory leaked.  Finally, *aliasing* (e.g., using all or
/// part of an object as both source and destination) is supported in all
/// cases.
///
/// See @ref bdlb_bigendian 
class BigEndianUint32 {
 
    // DATA
    unsigned int d_value;  // in-core value (network byte-order)
 
    // FRIENDS
    friend bool operator==(const BigEndianUint32& lhs,
                           const BigEndianUint32& rhs);
    friend bool operator!=(const BigEndianUint32& lhs,
                           const BigEndianUint32& rhs);
 
  public:
    // TRAITS
    BSLMF_NESTED_TRAIT_DECLARATION(BigEndianUint32,
                                   bsl::is_trivially_copyable);
    BSLMF_NESTED_TRAIT_DECLARATION(BigEndianUint32, bdlb::HasPrintMethod);
 
    // CLASS METHODS
 
    /// Create and initialize a `BigEndianUint32` object that stores the
    /// specified `value` as a unsigned 32-bit big-endian integer.
    static BigEndianUint32 make(unsigned int value);
 
#ifndef BDE_OMIT_INTERNAL_DEPRECATED
    /// Return the most current BDEX streaming version number supported by
    /// this class.  See the `bslx` package-level documentation for more
    /// information on BDEX streaming of value-semantic types and
    /// containers.
    static int maxSupportedBdexVersion();
#endif  // BDE_OMIT_INTERNAL_DEPRECATED
 
    /// Return the maximum valid BDEX format version, as indicated by the
    /// specified `versionSelector`, to be passed to the `bdexStreamOut` method.  
    /// 
    /// \note Note that   the `versionSelector` is expected to be formatted
    /// as `yyyymmdd`, a date representation.  See the `bslx` package-level
    /// documentation for more information on BDEX streaming of
    /// value-semantic types and containers.
    static int maxSupportedBdexVersion(int versionSelector);
 
    // CREATORS
     BigEndianUint32() = default;
     BigEndianUint32(const BigEndianUint32& other) = default;
     ~BigEndianUint32() = default;
 
    // MANIPULATORS
     BigEndianUint32& operator=(const BigEndianUint32& other) = default;
 
    /// Store in this object the specified `value` as an unsigned 32-bit
    /// big-endian integer, and return a reference to this modifiable
    /// object.
    BigEndianUint32& operator=(unsigned int value);
 
    /// Assign to this object the value read from the specified input
    /// `stream` using the specified `version` format, and return a
    /// reference to `stream`.  If `stream` is initially invalid, this
    /// operation has no effect.  If `version` is not supported, this object
    /// is unaltered and `stream` is invalidated but otherwise unmodified.
    /// If `version` is supported but `stream` becomes invalid during this
    /// operation, this object has an undefined, but valid, state.  
    /// 
    /// \note Note that   no version is read from `stream`.  See the `bslx` package-level
    /// documentation for more information on BDEX streaming of
    /// value-semantic types and containers.
    template <class STREAM>
    STREAM& bdexStreamIn(STREAM& stream, int version);
 
    // ACCESSORS
 
    /// Return the value stored in this object as a `unsigned int` in the
    /// native byte-order.
    operator unsigned int() const;
 
    /// Format this object to the specified output `stream` at the (absolute
    /// value of) the optionally specified indentation `level` and return a
    /// reference to `stream`.  If `level` is specified, optionally specify
    /// `spacesPerLevel`, the number of spaces per indentation level for
    /// this and all of its nested objects.  If `level` is negative,
    /// suppress indentation of the first line.  If `spacesPerLevel` is
    /// negative, format the entire output on one line, suppressing all but
    /// the initial indentation (as governed by `level`).  If `stream` is
    /// not valid on entry, this operation has no effect.
    bsl::ostream& print(bsl::ostream& stream,
                        int           level = 0,
                        int           spacesPerLevel = 4) const;
 
    /// Write this value to the specified output `stream` using the
    /// specified `version` format, and return a reference to `stream`.  If
    /// `stream` is initially invalid, this operation has no effect.  If
    /// `version` is not supported, `stream` is invalidated but otherwise unmodified.  
    /// 
    /// \note Note that   `version` is not written to `stream`.  See
    /// the `bslx` package-level documentation for more information on BDEX
    /// streaming of value-semantic types and containers.
    template <class STREAM>
    STREAM& bdexStreamOut(STREAM& stream, int version) const;
};
 
// FREE OPERATORS
 
/// Return `true` if the specified `lhs` and `rhs` `BigEndianUint32` objects
/// have the same value, and `false` otherwise.  Two `BigEndianUint32`
/// objects have the same value if and only if the respective integral
/// network byte-order values that they represent have the same value.
bool operator==(const BigEndianUint32& lhs, const BigEndianUint32& rhs);
 
/// Return `true` if the specified `lhs` and `rhs` `BigEndianUint32` objects
/// do not have the same value, and `false` otherwise.  Two
/// `BigEndianUint32` objects do not have the same value if and only if the
/// respective integral network byte-order values that they represent do not
/// have the same value.
bool operator!=(const BigEndianUint32& lhs, const BigEndianUint32& rhs);
 
/// Write the specified `integer` to the specified output `stream`, and
/// return a reference to the modifiable `stream`.
bsl::ostream& operator<<(bsl::ostream&          stream,
                         const BigEndianUint32& integer);
 
/// Invoke the specified `hashAlgorithm` on the attributes of the specified
/// `object`.
template <class HASH_ALGORITHM>
void hashAppend(HASH_ALGORITHM& hashAlgorithm, const BigEndianUint32& object);
 
                         // ====================
                         // class BigEndianInt64
                         // ====================
 
/// This class provides a container for an in-core representation of a
/// signed 64-bit big-endian integer.  It supports a complete set of *value*
/// *semantic* operations, including copy construction, assignment, equality
/// comparison, `bsl::ostream` printing, and BDEX serialization.  
/// 
/// \note Note that   the copy constructor and copy-assignment operator are provided by the
/// compiler.  Any object of this class can be converted to an `Int64`
/// allowing comparison with any other object of this class.  This class is
/// *exception* *neutral* with no guarantee of rollback: if an exception is
/// thrown during the invocation of a method on a pre-existing object, the
/// object is left in a valid state, but its value is undefined.  In no
/// event is memory leaked.  Finally, *aliasing* (e.g., using all or part of
/// an object as both source and destination) is supported in all cases.
///
/// See @ref bdlb_bigendian 
class BigEndianInt64 {
 
    // DATA
    bsls::Types::Int64 d_value;  // in-core value (network byte-order)
 
    // FRIENDS
    friend bool operator==(const BigEndianInt64& lhs,
                           const BigEndianInt64& rhs);
    friend bool operator!=(const BigEndianInt64& lhs,
                           const BigEndianInt64& rhs);
 
  public:
    // TRAITS
    BSLMF_NESTED_TRAIT_DECLARATION(BigEndianInt64, bsl::is_trivially_copyable);
    BSLMF_NESTED_TRAIT_DECLARATION(BigEndianInt64, bdlb::HasPrintMethod);
 
    // CLASS METHODS
 
    /// Create and initialize a `BigEndianInt64` object that stores the
    /// specified `value` as a signed 64-bit big-endian integer.
    static BigEndianInt64 make(bsls::Types::Int64 value);
 
#ifndef BDE_OMIT_INTERNAL_DEPRECATED
 
    /// Return the most current BDEX streaming version number supported by
    /// this class.  See the `bslx` package-level documentation for more
    /// information on BDEX streaming of value-semantic types and
    /// containers.
    static int maxSupportedBdexVersion();
#endif  // BDE_OMIT_INTERNAL_DEPRECATED
 
    /// Return the maximum valid BDEX format version, as indicated by the
    /// specified `versionSelector`, to be passed to the `bdexStreamOut` method.  
    /// 
    /// \note Note that   the `versionSelector` is expected to be formatted
    /// as `yyyymmdd`, a date representation.  See the `bslx` package-level
    /// documentation for more information on BDEX streaming of
    /// value-semantic types and containers.
    static int maxSupportedBdexVersion(int versionSelector);
 
    // CREATORS
     BigEndianInt64() = default;
     BigEndianInt64(const BigEndianInt64& other) = default;
     ~BigEndianInt64() = default;
 
    // MANIPULATORS
     BigEndianInt64& operator=(const BigEndianInt64& other) = default;
 
    /// Store in this object the specified `value` as a signed 64-bit
    /// big-endian integer, and return a reference to this modifiable
    /// object.
    BigEndianInt64& operator=(bsls::Types::Int64 value);
 
    /// Assign to this object the value read from the specified input
    /// `stream` using the specified `version` format, and return a
    /// reference to `stream`.  If `stream` is initially invalid, this
    /// operation has no effect.  If `version` is not supported, this object
    /// is unaltered and `stream` is invalidated but otherwise unmodified.
    /// If `version` is supported but `stream` becomes invalid during this
    /// operation, this object has an undefined, but valid, state.  
    /// 
    /// \note Note that   no version is read from `stream`.  See the `bslx` package-level
    /// documentation for more information on BDEX streaming of
    /// value-semantic types and containers.
    template <class STREAM>
    STREAM& bdexStreamIn(STREAM& stream, int version);
 
    // ACCESSORS
 
    /// Return the value stored in this object as a `bsls::Types::Int64` in
    /// the native byte-order.
    operator bsls::Types::Int64() const;
 
    /// Format this object to the specified output `stream` at the (absolute
    /// value of) the optionally specified indentation `level` and return a
    /// reference to `stream`.  If `level` is specified, optionally specify
    /// `spacesPerLevel`, the number of spaces per indentation level for
    /// this and all of its nested objects.  If `level` is negative,
    /// suppress indentation of the first line.  If `spacesPerLevel` is
    /// negative, format the entire output on one line, suppressing all but
    /// the initial indentation (as governed by `level`).  If `stream` is
    /// not valid on entry, this operation has no effect.
    bsl::ostream& print(bsl::ostream& stream,
                        int           level = 0,
                        int           spacesPerLevel = 4) const;
 
    /// Write this value to the specified output `stream` using the
    /// specified `version` format, and return a reference to `stream`.  If
    /// `stream` is initially invalid, this operation has no effect.  If
    /// `version` is not supported, `stream` is invalidated but otherwise unmodified.  
    /// 
    /// \note Note that   `version` is not written to `stream`.  See
    /// the `bslx` package-level documentation for more information on BDEX
    /// streaming of value-semantic types and containers.
    template <class STREAM>
    STREAM& bdexStreamOut(STREAM& stream, int version) const;
};
 
// FREE OPERATORS
 
/// Return `true` if the specified `lhs` and `rhs` `BigEndianInt64` objects
/// have the same value, and `false` otherwise.  Two `BigEndianInt64`
/// objects have the same value if and only if the respective integral
/// network byte-order values that they represent have the same value.
bool operator==(const BigEndianInt64& lhs, const BigEndianInt64& rhs);
 
/// Return `true` if the specified `lhs` and `rhs` `BigEndianInt64` objects
/// do not have the same value, and `false` otherwise.  Two `BigEndianInt64`
/// objects do not have the same value if and only if the respective
/// integral network byte-order values that they represent do not have the
/// same value.
bool operator!=(const BigEndianInt64& lhs, const BigEndianInt64& rhs);
 
/// Write the specified `integer` to the specified output `stream`, and
/// return a reference to the modifiable `stream`.
bsl::ostream& operator<<(bsl::ostream&         stream,
                         const BigEndianInt64& integer);
 
/// Invoke the specified `hashAlgorithm` on the attributes of the specified
/// `object`.
template <class HASH_ALGORITHM>
void hashAppend(HASH_ALGORITHM& hashAlgorithm, const BigEndianInt64& object);
 
                         // =====================
                         // class BigEndianUint64
                         // =====================
 
/// This class provides a container for an in-core representation of an
/// unsigned 64-bit big-endian integer.  It supports a complete set of
/// *value* *semantic* operations, including copy construction, assignment,
/// equality comparison, `bsl::ostream` printing, and BDEX serialization. 
/// 
/// \note Note that   the copy constructor and copy-assignment operator are provided
/// by the compiler.  Any object of this class can be converted to a
/// `Uint64` allowing comparison with any other object of this class.  This
/// class is *exception* *neutral* with no guarantee of rollback: if an
/// exception is thrown during the invocation of a method on a pre-existing
/// object, the object is left in a valid state, but its value is undefined.
/// In no event is memory leaked.  Finally, *aliasing* (e.g., using all or
/// part of an object as both source and destination) is supported in all
/// cases.
///
/// See @ref bdlb_bigendian 
class BigEndianUint64 {
 
    // DATA
    bsls::Types::Uint64 d_value;  // in-core value (network byte-order)
 
    // FRIENDS
    friend bool operator==(const BigEndianUint64& lhs,
                           const BigEndianUint64& rhs);
    friend bool operator!=(const BigEndianUint64& lhs,
                           const BigEndianUint64& rhs);
 
  public:
    // TRAITS
    BSLMF_NESTED_TRAIT_DECLARATION(BigEndianUint64,
                                   bsl::is_trivially_copyable);
    BSLMF_NESTED_TRAIT_DECLARATION(BigEndianUint64, bdlb::HasPrintMethod);
 
    // CLASS METHODS
 
    /// Create and initialize a `BigEndianInt64` object that stores the
    /// specified `value` as an unsigned 64-bit big-endian integer.
    static BigEndianUint64 make(bsls::Types::Uint64 value);
 
#ifndef BDE_OMIT_INTERNAL_DEPRECATED
    /// Return the most current BDEX streaming version number supported by
    /// this class.  See the `bslx` package-level documentation for more
    /// information on BDEX streaming of value-semantic types and
    /// containers.
    static int maxSupportedBdexVersion();
#endif  // BDE_OMIT_INTERNAL_DEPRECATED
 
    /// Return the maximum valid BDEX format version, as indicated by the
    /// specified `versionSelector`, to be passed to the `bdexStreamOut` method.  
    /// 
    /// \note Note that   the `versionSelector` is expected to be formatted
    /// as `yyyymmdd`, a date representation.  See the `bslx` package-level
    /// documentation for more information on BDEX streaming of
    /// value-semantic types and containers.
    static int maxSupportedBdexVersion(int versionSelector);
 
    // CREATORS
     BigEndianUint64() = default;
     BigEndianUint64(const BigEndianUint64& other) = default;
     ~BigEndianUint64() = default;
 
    // MANIPULATORS
     BigEndianUint64& operator=(const BigEndianUint64& other) = default;
 
    /// Store in this object the specified `value` as an unsigned 64-bit
    /// big-endian integer, and return a reference to this modifiable
    /// object.
    BigEndianUint64& operator=(bsls::Types::Uint64 value);
 
    /// Assign to this object the value read from the specified input
    /// `stream` using the specified `version` format, and return a
    /// reference to `stream`.  If `stream` is initially invalid, this
    /// operation has no effect.  If `version` is not supported, this object
    /// is unaltered and `stream` is invalidated but otherwise unmodified.
    /// If `version` is supported but `stream` becomes invalid during this
    /// operation, this object has an undefined, but valid, state.  
    /// 
    /// \note Note that   no version is read from `stream`.  See the `bslx` package-level
    /// documentation for more information on BDEX streaming of
    /// value-semantic types and containers.
    template <class STREAM>
    STREAM& bdexStreamIn(STREAM& stream, int version);
 
    // ACCESSORS
 
    /// Return the value stored in this object as a `bsls::Types::Uint64` in
    /// the native byte-order.
    operator bsls::Types::Uint64() const;
 
    /// Format this object to the specified output `stream` at the (absolute
    /// value of) the optionally specified indentation `level` and return a
    /// reference to `stream`.  If `level` is specified, optionally specify
    /// `spacesPerLevel`, the number of spaces per indentation level for
    /// this and all of its nested objects.  If `level` is negative,
    /// suppress indentation of the first line.  If `spacesPerLevel` is
    /// negative, format the entire output on one line, suppressing all but
    /// the initial indentation (as governed by `level`).  If `stream` is
    /// not valid on entry, this operation has no effect.
    bsl::ostream& print(bsl::ostream& stream,
                        int           level = 0,
                        int           spacesPerLevel = 4) const;
 
    /// Write this value to the specified output `stream` using the
    /// specified `version` format, and return a reference to `stream`.  If
    /// `stream` is initially invalid, this operation has no effect.  If
    /// `version` is not supported, `stream` is invalidated but otherwise unmodified.  
    /// 
    /// \note Note that   `version` is not written to `stream`.  See
    /// the `bslx` package-level documentation for more information on BDEX
    /// streaming of value-semantic types and containers.
    template <class STREAM>
    STREAM& bdexStreamOut(STREAM& stream, int version) const;
};
 
// FREE OPERATORS
 
/// Return `true` if the specified `lhs` and `rhs` `BigEndianUint64` objects
/// have the same value, and `false` otherwise.  Two `BigEndianUint64`
/// objects have the same value if and only if the respective integral
/// network byte-order values that they represent have the same value.
bool operator==(const BigEndianUint64& lhs, const BigEndianUint64& rhs);
 
/// Return `true` if the specified `lhs` and `rhs` `BigEndianUint64` objects
/// do not have the same value, and `false` otherwise.  Two
/// `BigEndianUint64` objects do not have the same value if and only if the
/// respective integral network byte-order values that they represent do not
/// have the same value.
bool operator!=(const BigEndianUint64& lhs, const BigEndianUint64& rhs);
 
/// Write the specified `integer` to the specified output `stream`, and
/// return a reference to the modifiable `stream`.
bsl::ostream& operator<<(bsl::ostream& stream, const BigEndianUint64& integer);
 
/// Invoke the specified `hashAlgorithm` on the attributes of the specified
/// `object`.
template <class HASH_ALGORITHM>
void hashAppend(HASH_ALGORITHM& hashAlgorithm, const BigEndianUint64& object);
 
// ============================================================================
//                               INLINE DEFINITIONS
// ============================================================================
 
                         // --------------------
                         // class BigEndianInt16
                         // --------------------
 
// CLASS METHODS
inline
BigEndianInt16 BigEndianInt16::make(short value)
{
    BigEndianInt16 ret;
    return ret = value;
}
 
#ifndef BDE_OMIT_INTERNAL_DEPRECATED
inline
int BigEndianInt16::maxSupportedBdexVersion()
{
    return maxSupportedBdexVersion(0);
}
#endif  // BDE_OMIT_INTERNAL_DEPRECATED
 
inline
int BigEndianInt16::maxSupportedBdexVersion(int /* versionSelector */)
{
    return 1;
}
 
// MANIPULATORS
inline
BigEndianInt16& BigEndianInt16::operator=(short value)
{
    d_value = BSLS_BYTEORDER_HOST_U16_TO_BE(value);
    return *this;
}
 
template <class STREAM>
STREAM& BigEndianInt16::bdexStreamIn(STREAM& stream, int version)
{
    if (stream) {
        switch (version) {
          case 1: {
            stream.getArrayUint8(reinterpret_cast<unsigned char *>(&d_value),
                                 sizeof d_value);
          } break;
          default: {
            stream.invalidate();
          }
        }
    }
    return stream;
}
}  // close package namespace
 
// ACCESSORS
inline
bdlb::BigEndianInt16::operator short() const
{
    return BSLS_BYTEORDER_BE_U16_TO_HOST(d_value);
}
 
namespace bdlb {
template <class STREAM>
STREAM& BigEndianInt16::bdexStreamOut(STREAM& stream, int version) const
{
    switch (version) {
      case 1: {
        stream.putArrayUint8(reinterpret_cast<const unsigned char *>(&d_value),
                             sizeof d_value);
      } break;
      default: {
        stream.invalidate();
      }
    }
    return stream;
}
}  // close package namespace
 
// FREE OPERATORS
inline
bool bdlb::operator==(const BigEndianInt16& lhs, const BigEndianInt16& rhs)
{
    return lhs.d_value == rhs.d_value;
}
 
inline
bool bdlb::operator!=(const BigEndianInt16& lhs, const BigEndianInt16& rhs)
{
    return lhs.d_value != rhs.d_value;
}
 
inline
bsl::ostream& bdlb::operator<<(bsl::ostream&         stream,
                               const BigEndianInt16& integer)
{
    integer.print(stream, 0, -1);
    return stream;
}
 
template <class HASH_ALGORITHM>
inline
void bdlb::hashAppend(HASH_ALGORITHM&       hashAlgorithm,
                      const BigEndianInt16& object)
{
    hashAlgorithm(reinterpret_cast<const char *>(&object),
                  sizeof(BigEndianInt16));
}
 
namespace bdlb {
                         // ---------------------
                         // class BigEndianUint16
                         // ---------------------
 
// CLASS METHODS
inline
BigEndianUint16 BigEndianUint16::make(unsigned short value)
{
    BigEndianUint16 ret;
    return ret = value;
}
 
#ifndef BDE_OMIT_INTERNAL_DEPRECATED
inline
int BigEndianUint16::maxSupportedBdexVersion()
{
    return maxSupportedBdexVersion(0);
}
#endif  // BDE_OMIT_INTERNAL_DEPRECATED
 
inline
int BigEndianUint16::maxSupportedBdexVersion(int /* versionSelector */)
{
    return 1;
}
 
// MANIPULATORS
inline
BigEndianUint16& BigEndianUint16::operator=(unsigned short value)
{
    d_value = BSLS_BYTEORDER_HOST_U16_TO_BE(value);
    return *this;
}
 
template <class STREAM>
STREAM& BigEndianUint16::bdexStreamIn(STREAM& stream, int version)
{
    if (stream) {
        switch (version) {
          case 1: {
            stream.getArrayUint8(reinterpret_cast<unsigned char *>(&d_value),
                                 sizeof d_value);
          } break;
          default: {
            stream.invalidate();
          }
        }
    }
    return stream;
}
}  // close package namespace
 
// ACCESSORS
inline
bdlb::BigEndianUint16::operator unsigned short() const
{
    return BSLS_BYTEORDER_BE_U16_TO_HOST(d_value);
}
 
namespace bdlb {
template <class STREAM>
STREAM& BigEndianUint16::bdexStreamOut(STREAM& stream, int version) const
{
    switch (version) {
      case 1: {
        stream.putArrayUint8(reinterpret_cast<const unsigned char *>(&d_value),
                             sizeof d_value);
      } break;
      default: {
        stream.invalidate();
      }
    }
    return stream;
}
}  // close package namespace
 
// FREE OPERATORS
inline
bool bdlb::operator==(const BigEndianUint16& lhs, const BigEndianUint16& rhs)
{
    return lhs.d_value == rhs.d_value;
}
 
inline
bool bdlb::operator!=(const BigEndianUint16& lhs, const BigEndianUint16& rhs)
{
    return lhs.d_value != rhs.d_value;
}
 
inline
bsl::ostream& bdlb::operator<<(bsl::ostream&          stream,
                               const BigEndianUint16& integer)
{
    integer.print(stream, 0, -1);
    return stream;
}
 
template <class HASH_ALGORITHM>
inline
void bdlb::hashAppend(HASH_ALGORITHM&        hashAlgorithm,
                      const BigEndianUint16& object)
{
    hashAlgorithm(reinterpret_cast<const char *>(&object),
                  sizeof(BigEndianUint16));
}
 
namespace bdlb {
                         // --------------------
                         // class BigEndianInt32
                         // --------------------
 
// CLASS METHODS
inline
BigEndianInt32 BigEndianInt32::make(int value)
{
    BigEndianInt32 ret;
    return ret = value;
}
 
#ifndef BDE_OMIT_INTERNAL_DEPRECATED
inline
int BigEndianInt32::maxSupportedBdexVersion()
{
    return maxSupportedBdexVersion(0);
}
#endif  // BDE_OMIT_INTERNAL_DEPRECATED
 
inline
int BigEndianInt32::maxSupportedBdexVersion(int /* versionSelector */)
{
    return 1;
}
 
// MANIPULATORS
inline
BigEndianInt32& BigEndianInt32::operator=(int value)
{
    d_value = BSLS_BYTEORDER_HOST_U32_TO_BE(value);
    return *this;
}
 
template <class STREAM>
STREAM& BigEndianInt32::bdexStreamIn(STREAM& stream, int version)
{
    switch (version) {
      case 1: {
        stream.getArrayUint8(reinterpret_cast<unsigned char *>(&d_value),
                             sizeof d_value);
      } break;
      default: {
        stream.invalidate();
      }
    }
    return stream;
}
}  // close package namespace
 
// ACCESSORS
inline
bdlb::BigEndianInt32::operator int() const
{
    return BSLS_BYTEORDER_BE_U32_TO_HOST(d_value);
}
 
namespace bdlb {
template <class STREAM>
STREAM& BigEndianInt32::bdexStreamOut(STREAM& stream, int version) const
{
    switch (version) {
      case 1: {
        stream.putArrayUint8(reinterpret_cast<const unsigned char *>(&d_value),
                             sizeof d_value);
      } break;
      default: {
        stream.invalidate();
      }
    }
    return stream;
}
}  // close package namespace
 
// FREE OPERATORS
inline
bool bdlb::operator==(const BigEndianInt32& lhs, const BigEndianInt32& rhs)
{
    return lhs.d_value == rhs.d_value;
}
 
inline
bool bdlb::operator!=(const BigEndianInt32& lhs, const BigEndianInt32& rhs)
{
    return lhs.d_value != rhs.d_value;
}
 
inline
bsl::ostream& bdlb::operator<<(bsl::ostream&         stream,
                               const BigEndianInt32& integer)
{
    integer.print(stream, 0, -1);
    return stream;
}
 
template <class HASH_ALGORITHM>
inline
void bdlb::hashAppend(HASH_ALGORITHM&       hashAlgorithm,
                      const BigEndianInt32& object)
{
    hashAlgorithm(reinterpret_cast<const char *>(&object),
                  sizeof(BigEndianInt32));
}
 
namespace bdlb {
                         // ---------------------
                         // class BigEndianUint32
                         // ---------------------
 
// CLASS METHODS
inline
BigEndianUint32 BigEndianUint32::make(unsigned int value)
{
    BigEndianUint32 ret;
    return ret = value;
}
 
#ifndef BDE_OMIT_INTERNAL_DEPRECATED
inline
int BigEndianUint32::maxSupportedBdexVersion()
{
    return maxSupportedBdexVersion(0);
}
#endif  // BDE_OMIT_INTERNAL_DEPRECATED
 
inline
int BigEndianUint32::maxSupportedBdexVersion(int /* versionSelector */)
{
    return 1;
}
 
// MANIPULATORS
inline
BigEndianUint32& BigEndianUint32::operator=(unsigned int value)
{
    d_value = BSLS_BYTEORDER_HOST_U32_TO_BE(value);
    return *this;
}
 
template <class STREAM>
STREAM& BigEndianUint32::bdexStreamIn(STREAM& stream, int version)
{
    if (stream) {
        switch (version) {
          case 1: {
            stream.getArrayUint8(reinterpret_cast<unsigned char *>(&d_value),
                                 sizeof d_value);
          } break;
          default: {
            stream.invalidate();
          }
        }
    }
    return stream;
}
}  // close package namespace
 
// ACCESSORS
inline
bdlb::BigEndianUint32::operator unsigned int() const
{
    return BSLS_BYTEORDER_BE_U32_TO_HOST(d_value);
}
 
namespace bdlb {
template <class STREAM>
STREAM& BigEndianUint32::bdexStreamOut(STREAM& stream, int version) const
{
    switch (version) {
      case 1: {
        stream.putArrayUint8(reinterpret_cast<const unsigned char *>(&d_value),
                             sizeof d_value);
      } break;
      default: {
        stream.invalidate();
      }
    }
    return stream;
}
}  // close package namespace
 
// FREE OPERATORS
inline
bool bdlb::operator==(const BigEndianUint32& lhs, const BigEndianUint32& rhs)
{
    return lhs.d_value == rhs.d_value;
}
 
inline
bool bdlb::operator!=(const BigEndianUint32& lhs, const BigEndianUint32& rhs)
{
    return lhs.d_value != rhs.d_value;
}
 
inline
bsl::ostream& bdlb::operator<<(bsl::ostream&          stream,
                               const BigEndianUint32& integer)
{
    integer.print(stream, 0, -1);
    return stream;
}
 
template <class HASH_ALGORITHM>
inline
void bdlb::hashAppend(HASH_ALGORITHM&        hashAlgorithm,
                      const BigEndianUint32& object)
{
    hashAlgorithm(reinterpret_cast<const char *>(&object),
                  sizeof(BigEndianUint32));
}
 
namespace bdlb {
                         // --------------------
                         // class BigEndianInt64
                         // --------------------
 
// CLASS METHODS
inline
BigEndianInt64 BigEndianInt64::make(bsls::Types::Int64 value)
{
    BigEndianInt64 ret;
    return ret = value;
}
 
#ifndef BDE_OMIT_INTERNAL_DEPRECATED
inline
int BigEndianInt64::maxSupportedBdexVersion()
{
    return maxSupportedBdexVersion(0);
}
#endif  // BDE_OMIT_INTERNAL_DEPRECATED
 
inline
int BigEndianInt64::maxSupportedBdexVersion(int /* versionSelector */)
{
    return 1;
}
 
// MANIPULATORS
inline
BigEndianInt64& BigEndianInt64::operator=(bsls::Types::Int64 value)
{
    d_value = BSLS_BYTEORDER_HOST_U64_TO_BE(value);
    return *this;
}
 
template <class STREAM>
STREAM& BigEndianInt64::bdexStreamIn(STREAM& stream, int version)
{
    switch (version) {
      case 1: {
        stream.getArrayUint8(reinterpret_cast<unsigned char *>(&d_value),
                             sizeof d_value);
      } break;
      default: {
        stream.invalidate();
      }
    }
    return stream;
}
}  // close package namespace
 
// ACCESSORS
inline
bdlb::BigEndianInt64::operator bsls::Types::Int64() const
{
    return BSLS_BYTEORDER_BE_U64_TO_HOST(d_value);
}
 
namespace bdlb {
template <class STREAM>
STREAM& BigEndianInt64::bdexStreamOut(STREAM& stream, int version) const
{
    switch (version) {
      case 1: {
        stream.putArrayUint8(reinterpret_cast<const unsigned char *>(&d_value),
                             sizeof d_value);
      } break;
      default: {
        stream.invalidate();
      }
    }
    return stream;
}
}  // close package namespace
 
// FREE OPERATORS
inline
bool bdlb::operator==(const BigEndianInt64& lhs, const BigEndianInt64& rhs)
{
    return lhs.d_value == rhs.d_value;
}
 
inline
bool bdlb::operator!=(const BigEndianInt64& lhs, const BigEndianInt64& rhs)
{
    return lhs.d_value != rhs.d_value;
}
 
inline
bsl::ostream& bdlb::operator<<(bsl::ostream&         stream,
                               const BigEndianInt64& integer)
{
    integer.print(stream, 0, -1);
    return stream;
}
 
template <class HASH_ALGORITHM>
inline
void bdlb::hashAppend(HASH_ALGORITHM&       hashAlgorithm,
                      const BigEndianInt64& object)
{
    hashAlgorithm(reinterpret_cast<const char *>(&object),
                  sizeof(BigEndianInt64));
}
 
namespace bdlb {
                         // ---------------------
                         // class BigEndianUint64
                         // ---------------------
 
// CLASS METHODS
inline
BigEndianUint64 BigEndianUint64::make(bsls::Types::Uint64 value)
{
    BigEndianUint64 ret;
    return ret = value;
}
 
#ifndef BDE_OMIT_INTERNAL_DEPRECATED
inline
int BigEndianUint64::maxSupportedBdexVersion()
{
    return maxSupportedBdexVersion(0);
}
#endif  // BDE_OMIT_INTERNAL_DEPRECATED
 
inline
int BigEndianUint64::maxSupportedBdexVersion(int /* versionSelector */)
{
    return 1;
}
 
// MANIPULATORS
inline
BigEndianUint64& BigEndianUint64::operator=(bsls::Types::Uint64 value)
{
    d_value = BSLS_BYTEORDER_HOST_U64_TO_BE(value);
    return *this;
}
 
template <class STREAM>
STREAM& BigEndianUint64::bdexStreamIn(STREAM& stream, int version)
{
    switch (version) {
      case 1: {
        stream.getArrayUint8(reinterpret_cast<unsigned char *>(&d_value),
                             sizeof d_value);
      } break;
      default: {
        stream.invalidate();
      }
    }
    return stream;
}
}  // close package namespace
 
// ACCESSORS
inline
bdlb::BigEndianUint64::operator bsls::Types::Uint64() const
{
    return BSLS_BYTEORDER_BE_U64_TO_HOST(d_value);
}
 
namespace bdlb {
template <class STREAM>
STREAM& BigEndianUint64::bdexStreamOut(STREAM& stream, int version) const
{
    switch (version) {
      case 1: {
        stream.putArrayUint8(reinterpret_cast<const unsigned char *>(&d_value),
                             sizeof d_value);
      } break;
      default: {
        stream.invalidate();
      }
    }
    return stream;
}
}  // close package namespace
 
// FREE OPERATORS
inline
bool bdlb::operator==(const BigEndianUint64& lhs, const BigEndianUint64& rhs)
{
    return lhs.d_value == rhs.d_value;
}
 
inline
bool bdlb::operator!=(const BigEndianUint64& lhs, const BigEndianUint64& rhs)
{
    return lhs.d_value != rhs.d_value;
}
 
inline
bsl::ostream& bdlb::operator<<(bsl::ostream&          stream,
                               const BigEndianUint64& integer)
{
    integer.print(stream, 0, -1);
    return stream;
}
 
template <class HASH_ALGORITHM>
inline
void bdlb::hashAppend(HASH_ALGORITHM&        hashAlgorithm,
                      const BigEndianUint64& object)
{
    hashAlgorithm(reinterpret_cast<const char *>(&object),
                  sizeof(BigEndianUint64));
}
 
 
 
#endif
 
// ----------------------------------------------------------------------------
// Copyright 2015 Bloomberg Finance L.P.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ----------------------------- END-OF-FILE ----------------------------------
 
/** @} */
/** @} */
/** @} */