SignallingDumpable Class Reference
A data dumping capable component.
More...
#include <yatesig.h>
List of all members.
Detailed Description
A data dumping capable component.
A generic base class for components capable of creating data dumps
Constructor & Destructor Documentation
Destructor - destroys the data dumper
Constructor
- Parameters:
-
| type | Default type of the data dumper |
| network | True if we are the network side of the link |
Member Function Documentation
Handle dumper related control on behalf of the owning component
- Parameters:
-
| params | Control parameters to handle |
| owner | Optional owning component |
- Returns:
- True if control operation was applied
bool dump |
( |
const DataBlock & |
data, |
|
|
bool |
sent = false , |
|
|
int |
link = 0 | |
|
) |
| | [inline, protected] |
bool dump |
( |
void * |
buf, |
|
|
unsigned int |
len, |
|
|
bool |
sent = false , |
|
|
int |
link = 0 | |
|
) |
| | [inline, protected] |
Dump the provided data if the dumper is valid
- Parameters:
-
| buf | Pointer to buffer to dump |
| len | Length of the data |
| sent | True if data is being sent, false if is being received |
| link | Link number (relevant to MTP2 only) |
- Returns:
- True if the data was dumped successfully
bool setDumper |
( |
const String & |
name, |
|
|
bool |
create = true , |
|
|
bool |
append = false | |
|
) |
| | [protected] |
Set or remove a file data dumper
- Parameters:
-
| name | Name of the file to dump to, empty to remove dumper |
| create | True to create the file if doesn't exist |
| append | Append to an existing file. If false and the file already exists, it will be truncated |
- Returns:
- True if the file dumper was created or removed
Set or remove the data dumper
- Parameters:
-
| dumper | Pointer to the data dumper object, 0 to remove |
void setDumpNetwork |
( |
bool |
network |
) |
[inline, protected] |
Set the dump network side flag
- Parameters:
-
| network | True to dump as network side, false othervise |
The documentation for this class was generated from the following file: