Yate
|
A data dumping capable component. More...
#include <yatesig.h>
Public Member Functions | |
~SignallingDumpable () | |
Protected Member Functions | |
SignallingDumpable (SignallingDumper::Type type, bool network=false) | |
bool | dump (void *buf, unsigned int len, bool sent=false, int link=0) |
bool | dump (const DataBlock &data, bool sent=false, int link=0) |
void | setDumpNetwork (bool network) |
void | setDumper (SignallingDumper *dumper=0) |
bool | setDumper (const String &name, bool create=true, bool append=false) |
bool | control (NamedList ¶ms, SignallingComponent *owner=0) |
A data dumping capable component.
A generic base class for components capable of creating data dumps
~SignallingDumpable | ( | ) | [inline] |
Destructor - destroys the data dumper
SignallingDumpable | ( | SignallingDumper::Type | type, |
bool | network = false |
||
) | [inline, protected] |
Constructor
type | Default type of the data dumper |
network | True if we are the network side of the link |
bool control | ( | NamedList & | params, |
SignallingComponent * | owner = 0 |
||
) | [protected] |
Handle dumper related control on behalf of the owning component
params | Control parameters to handle |
owner | Optional owning component |
bool dump | ( | const DataBlock & | data, |
bool | sent = false , |
||
int | link = 0 |
||
) | [inline, protected] |
Dump data if the dumper is valid
data | Buffer to dump |
sent | True if data is being sent, false if is being received |
link | Link number (relevant to MTP2 only) |
References DataBlock::data(), SignallingDumpable::dump(), and DataBlock::length().
Referenced by SignallingDumpable::dump().
bool dump | ( | void * | buf, |
unsigned int | len, | ||
bool | sent = false , |
||
int | link = 0 |
||
) | [inline, protected] |
Dump the provided data if the dumper is valid
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) |
void setDumper | ( | SignallingDumper * | dumper = 0 | ) | [protected] |
Set or remove the data dumper
dumper | Pointer to the data dumper object, 0 to remove |
bool setDumper | ( | const String & | name, |
bool | create = true , |
||
bool | append = false |
||
) | [protected] |
Set or remove a file data dumper
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 |
void setDumpNetwork | ( | bool | network | ) | [inline, protected] |
Set the dump network side flag
network | True to dump as network side, false othervise |