rti::util::network_capture::ContentKindMask Class Reference

<<extension>> Mask indicating the types of contents to remove from RTPS frames before saving them to the capture file. More...

#include <network_capture.hpp>

Inherits std::bitset< 32 >.

Public Types
typedef std::bitset< 32 >	MaskType
	A typedef of std::bitset<32> for convenience. More...

Public Member Functions
	ContentKindMask ()
	Default constructor for ContentKindMask. More...
	ContentKindMask (uint64_t mask)
	Construct a ContentKindMask from an integer. More...
	ContentKindMask (const MaskType &mask)
	Construct a ContentKindMask from a MaskType object. More...

Static Public Member Functions
static const ContentKindMask	user ()
	The serialized data coming from a user. More...
static const ContentKindMask	encrypted ()
	The encrypted user data. More...
static const ContentKindMask	default_mask ()
	Default mask for network_capture::ContentKindMask: do not remove any content. More...
static const ContentKindMask	none ()
	The RTPS frames in the capture file will be saved as they are. More...
static const ContentKindMask	all ()
	The RTPS frames in the capture file will not include user data (either plain or encrypted). More...

Detailed Description

<<extension>> Mask indicating the types of contents to remove from RTPS frames before saving them to the capture file.

The masks are based on a combination (or only one) of the network_capture::ContentKindMask bitmaps.

See also

network_capture::ContentKindMask

Member Typedef Documentation

MaskType

typedef std::bitset<32> rti::util::network_capture::ContentKindMask::MaskType

A typedef of std::bitset<32> for convenience.

Constructor & Destructor Documentation

ContentKindMask() [1/3]

rti::util::network_capture::ContentKindMask::ContentKindMask ( )

inline

Default constructor for ContentKindMask.

ContentKindMask() [2/3]

rti::util::network_capture::ContentKindMask::ContentKindMask ( uint64_t  mask )

inlineexplicit

Construct a ContentKindMask from an integer.

Parameters

mask	Value whose bits are copied to the bitset positions

ContentKindMask() [3/3]

rti::util::network_capture::ContentKindMask::ContentKindMask ( const MaskType &  mask )

inline

Construct a ContentKindMask from a MaskType object.

Parameters

mask	A std::bitset<32> to construct this NetworkCaptureContentKindMask from.

Member Function Documentation

user()

static const ContentKindMask rti::util::network_capture::ContentKindMask::user ( )

inlinestatic

The serialized data coming from a user.

encrypted()

static const ContentKindMask rti::util::network_capture::ContentKindMask::encrypted ( )

inlinestatic

The encrypted user data.

default_mask()

static const ContentKindMask rti::util::network_capture::ContentKindMask::default_mask ( )

inlinestatic

Default mask for network_capture::ContentKindMask: do not remove any content.

It is equivalent to network_capture::ContentKindMask::none().

[default] Do not remove any content.

none()

static const ContentKindMask rti::util::network_capture::ContentKindMask::none ( )

inlinestatic

The RTPS frames in the capture file will be saved as they are.

all()

static const ContentKindMask rti::util::network_capture::ContentKindMask::all ( )

inlinestatic

The RTPS frames in the capture file will not include user data (either plain or encrypted).

Its value is the result of setting the bits for removing user data and removing encrypted data: (network_capture::ContentKindMask::user()) | network_capture::ContentKindMask::encrypted())