Wiretap API  <small>Wiretap 2021.2</small>
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
WireTapFrameId Class Reference

This class contains an identifier for a frame in a database exposed by a Wiretap server. More...

Public Member Functions

const char * id () const
 Gets the identifier for a frame which is unique for a particular Wiretap server on a particular host. More...
 
WireTapFrameIdoperator= (const WireTapFrameId &src)=default
 Default assignment operator. Returns a reference to the source object. More...
 
WireTapFrameIdoperator= (WireTapFrameId &&src) noexcept=default
 Move assignment operator. Returns a reference to the source object. More...
 
void setId (const char *idString)
 Sets the identifier for a frame which is unique for a particular Wiretap server on a particular host. More...
 
 WireTapFrameId (const char *idString="")
 Constructs a new WireTapFrameId object using a string or, if no string is specified, using an empty string. More...
 
 WireTapFrameId (const WireTapStr &idObject)
 Constructs a new WireTapFrameId object using a reference to a WireTapStr object. More...
 
 WireTapFrameId (const WireTapFrameId &frameId)=default
 Copy constructor. More...
 
 WireTapFrameId (WireTapFrameId &&frameId) noexcept=default
 Move constructor. More...
 
virtual ~WireTapFrameId ()=default
 

Public Attributes

WireTapStr id_
 

Detailed Description

This class contains an identifier for a frame in a database exposed by a Wiretap server.

A frame identifier should be unique in the context of a particular instance of a particular Wiretap server.

WireTapNodeHandle uses the combination of this class (WireTapFrameId) and WireTapServerHandle to uniquely refer to a frame.

See Also
WireTapNodeHandle and WireTapServerHandle.

Constructor & Destructor Documentation

virtual WireTapFrameId::~WireTapFrameId ( )
virtualdefault
WireTapFrameId::WireTapFrameId ( const char *  idString = "")

Constructs a new WireTapFrameId object using a string or, if no string is specified, using an empty string.

Normally, only Wiretap servers call this constructor.

Parameters
idStringAn input parameter. A string that is an identifier for the frame that is unique in the context of an instance of a particular Wiretap server.
WireTapFrameId::WireTapFrameId ( const WireTapStr idObject)

Constructs a new WireTapFrameId object using a reference to a WireTapStr object.

Normally, only Wiretap servers call this constructor.

Parameters
idObjectAn input parameter. A WireTapStr object that contains a an identifier for the frame that is unique in the context of an instance of a particular Wiretap server.
WireTapFrameId::WireTapFrameId ( const WireTapFrameId frameId)
default

Copy constructor.

Constructs a new WireTapFrameId object that duplicates the content of the original.

Parameters
frameIdAn input parameter. The WiretapFrameId object that is to be copied.
WireTapFrameId::WireTapFrameId ( WireTapFrameId &&  frameId)
defaultnoexcept

Move constructor.

Constructs a new WireTapFrameId object that duplicates the content of the original.

Parameters
frameIdAn input parameter. The WiretapFrameId object that is to be moved.

Member Function Documentation

const char* WireTapFrameId::id ( ) const

Gets the identifier for a frame which is unique for a particular Wiretap server on a particular host.

Returns
A string that contains the identifier for the frame.
WireTapFrameId& WireTapFrameId::operator= ( const WireTapFrameId src)
default

Default assignment operator. Returns a reference to the source object.

Parameters
srcAn input parameter. The WireTapFrameId object to which the reference should point.
WireTapFrameId& WireTapFrameId::operator= ( WireTapFrameId &&  src)
defaultnoexcept

Move assignment operator. Returns a reference to the source object.

Parameters
srcAn input parameter. The WiretapFrameId object that is to be moved.
void WireTapFrameId::setId ( const char *  idString)

Sets the identifier for a frame which is unique for a particular Wiretap server on a particular host.

Parameters
idStringAn input parameter. A string that contains the identifier for the frame. The id should be unique among the frames for an instance of a particular Wiretap server on a particular host. This parameter cannot be NULL.

The following are not legal in a node ID:

  • space
  • comma
  • new line
  • tab
  • quote (single and double)

Member Data Documentation

WireTapStr WireTapFrameId::id_

The documentation for this class was generated from the following file: