RTI Connext Modern C++ API  Version 6.1.0
rti::util::network_capture::TrafficKindMask Class Reference

<<extension>> Mask indicating the traffic direction to capture. More...

#include <network_capture.hpp>

Inherits bitset< 32 >.

Public Types

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

Public Member Functions

 TrafficKindMask ()
 Default constructor for TrafficKindMask. More...
 
 TrafficKindMask (uint64_t mask)
 Construct a TrafficKindMask from an integer. More...
 
 TrafficKindMask (const MaskType &mask)
 Construct a TrafficKindMask from a MaskType object. More...
 

Static Public Member Functions

static const TrafficKindMask out ()
 Do not capture outbound traffic. More...
 
static const TrafficKindMask in ()
 Do not capture inbound traffic. More...
 
static const TrafficKindMask default_mask ()
 Default mask for network_capture::TrafficKindMask. More...
 
static const TrafficKindMask none ()
 Do not capture any traffic. More...
 
static const TrafficKindMask all ()
 Capture all traffic (both inbound and outbound). More...
 

Detailed Description

<<extension>> Mask indicating the traffic direction to capture.

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

See also
network_capture::TrafficKindMask

Member Typedef Documentation

◆ MaskType

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

Constructor & Destructor Documentation

◆ TrafficKindMask() [1/3]

rti::util::network_capture::TrafficKindMask::TrafficKindMask ( )
inline

Default constructor for TrafficKindMask.

◆ TrafficKindMask() [2/3]

rti::util::network_capture::TrafficKindMask::TrafficKindMask ( uint64_t  mask)
inlineexplicit

Construct a TrafficKindMask from an integer.

Parameters
maskValue whose bits are copied to the bitset positions

◆ TrafficKindMask() [3/3]

rti::util::network_capture::TrafficKindMask::TrafficKindMask ( const MaskType mask)
inline

Construct a TrafficKindMask from a MaskType object.

Parameters
maskA std::bitset<32> to construct this TrafficKindMask from.

Member Function Documentation

◆ out()

static const TrafficKindMask rti::util::network_capture::TrafficKindMask::out ( )
inlinestatic

Do not capture outbound traffic.

◆ in()

static const TrafficKindMask rti::util::network_capture::TrafficKindMask::in ( )
inlinestatic

Do not capture inbound traffic.

◆ default_mask()

static const TrafficKindMask rti::util::network_capture::TrafficKindMask::default_mask ( )
inlinestatic

Default mask for network_capture::TrafficKindMask.

It is equivalent to network_capture::TrafficKindMask::all().

[default] Capture all traffic: inbound and outbound.

◆ none()

static const TrafficKindMask rti::util::network_capture::TrafficKindMask::none ( )
inlinestatic

Do not capture any traffic.

◆ all()

static const TrafficKindMask rti::util::network_capture::TrafficKindMask::all ( )
inlinestatic

Capture all traffic (both inbound and outbound).

The value is equal to setting both the input and output bits of the mask: (network_capture::TrafficKindMask::out() | network_capture::TrafficKindMask::in()).