This class contains an identifier for a frame in a database exposed by a Wiretap server.
More...
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.
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
-
idString | An 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
-
idObject | An 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. |
Copy constructor.
Constructs a new WireTapFrameId object that duplicates the content of the original.
- Parameters
-
frameId | An input parameter. The WiretapFrameId object that is to be copied. |
Move constructor.
Constructs a new WireTapFrameId object that duplicates the content of the original.
- Parameters
-
frameId | An input parameter. The WiretapFrameId object that is to be moved. |
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.
Default assignment operator. Returns a reference to the source object.
- Parameters
-
src | An input parameter. The WireTapFrameId object to which the reference should point. |
Move assignment operator. Returns a reference to the source object.
- Parameters
-
src | An 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
-
idString | An 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)
The documentation for this class was generated from the following file: