Helper Wrapper Class to handle the additional Data entry of the Log Event ISampleLog::MSLEE_TransmitReceiveState .
More...
Helper Wrapper Class to handle the additional Data entry of the Log Event ISampleLog::MSLEE_TransmitReceiveState .
Storage class for the array of internal ISampleLog::tSampleLogTransmitReceiveState structure.
Definition at line 180 of file samplelogentry.h.
◆ AddEntry()
Adds an entry for the Creator ID ui64ID.
- Parameters
-
ui64ID | [in] The creator identifier the entry belongs to. (commonly this is the "InputPin ID"). |
- Return values
-
ERR_INVALID_STATE | Memory is locked ! |
ERR_MEMORY | no more memory available ! |
ERR_NOERROR | no error. |
◆ Clear()
Clears the Buffer.
- Return values
-
ERR_INVALID_STATE | MemoryLock(true) was called. |
ERR_NOERROR | succeeded. |
◆ LogBuffer()
Logs current buffer as ISampleLog::MSLEE_TransmitReceiveState event to the given oLogSample
.
- Parameters
-
ui64ID | [in] Creator ID of the Log entry creator (commonly the filter or the output pin of the filter). |
tmCurrent | [in] current time for the entry. |
pLogSample | [in] sample log where to add the entry. |
- Return values
-
ERR_INVALID_STATE | MemoryLock(true) was NOT called or no Entry in Buffer. |
ERR_NOERROR | Succeeded. |
◆ MemoryLock()
tResult MemoryLock |
( |
const bool & |
bLock | ) |
|
Locks the memory if bLock
is set to true.
No AddEntry call can be made anymore.
- Parameters
-
bLock | [in] true - lock, false - unlock |
- Returns
- ERR_NOERROR Succeeded.
◆ SetEntry()
Sets the values of an entry for the Creator ID ui64CreatorID
.
This ui64CreatorID must be unique !
- Parameters
-
ui64CreatorID | [in] The creator identifier the entry belongs to. (commonly this is the "InputPin ID"). |
ui32EventID | [in] The eventID (commonly Receive or Received) of the event which is currently valid on ui64CreatorID . |
tmEntryTime | [in] Time of the event ui32EventID. |
sSampleId | [in] SampleID which was valid on ui64CreatorID. |
- Return values
-
ERR_INVALID_INDEX | ui64CreatorID is not valid. call AddEntry before ! |
ERR_NOERROR | no error. |
◆ ToString()
static Helper function to serialize a single structure content of ISampleLog::tSampleLogTransmitReceiveState to a string strResult
.
- Parameters
-
sState | [in] The sState entry to serialize as String. |
strResult | [in, out] The whole entry as String. |
pHandleInfo | [in] A handle info callback to get valid names for ThreadID and CreatorID. |
strSeparator | [in] if separator is not empty a comma separated list will be generated for this entry. if separator is empty a log formated string will be generated. |
- Return values
-