RTI Connext Modern C++ API  Version 5.3.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
rti::core::Cookie Class Reference

Unique identifier for a written data sample in the form of a sequence of bytes. More...

#include <rti/core/Cookie.hpp>

Public Member Functions

 Cookie ()
 Creates an empty cookie.
 
template<typename ByteContainer >
 Cookie (const ByteContainer &bytes)
 Creates a new cookie with the bytes inside a container.
 
dds::core::vector< uint8_t > & value ()
 Retrieves a reference to the vector of bytes.
 
const dds::core::vector
< uint8_t > & 
value () const
 Retrieves a const reference to the vector of bytes.
 

Related Functions

(Note that these are not member functions.)

typedef dds::core::vector< CookieCookieSeq
 A sequence of Cookie objects.
 
std::ostream & operator<< (std::ostream &out, const Cookie &cookie)
 Prints a Cookie to an output stream.
 

Detailed Description

Unique identifier for a written data sample in the form of a sequence of bytes.

See Also
dds::pub::DataWriter::write(const T&, rti::pub::WriteParams&)

Constructor & Destructor Documentation

rti::core::Cookie::Cookie ( )
inline

Creates an empty cookie.

template<typename ByteContainer >
rti::core::Cookie::Cookie ( const ByteContainer &  bytes)
inlineexplicit

Creates a new cookie with the bytes inside a container.

Member Function Documentation

dds::core::vector<uint8_t>& rti::core::Cookie::value ( )

Retrieves a reference to the vector of bytes.

const dds::core::vector<uint8_t>& rti::core::Cookie::value ( ) const

Retrieves a const reference to the vector of bytes.

Friends And Related Function Documentation

A sequence of Cookie objects.

std::ostream & operator<< ( std::ostream &  out,
const Cookie cookie 
)
related

Prints a Cookie to an output stream.


RTI Connext Modern C++ API Version 5.3.1 Copyright © Mon Feb 19 2018 Real-Time Innovations, Inc