class SignallingDumpable

A data dumping capable component. More...

Full nameTelEngine::SignallingDumpable
Definition#include <libs/ysig/yatesig.h>
Inherited byISDNQ921, ISDNQ921Management, ISDNQ921Passive, ISDNQ931, SS7MTP2, SS7MTP3
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Methods


Detailed Description

A generic base class for components capable of creating data dumps

inline  ~SignallingDumpable ()

~SignallingDumpable

Destructor - destroys the data dumper

inline  SignallingDumpable (SignallingDumper::Type type, bool network = false)

SignallingDumpable

[protected]

Constructor

Parameters:
typeDefault type of the data dumper
networkTrue if we are the network side of the link

inline bool  dump (void* buf, unsigned int len, bool sent = false, int link = 0)

dump

[protected]

Dump the provided data if the dumper is valid

Parameters:
bufPointer to buffer to dump
lenLength of the data
sentTrue if data is being sent, false if is being received
linkLink number (relevant to MTP2 only)

Returns: True if the data was dumped successfully

inline bool  dump (const DataBlock& data, bool sent = false, int link = 0)

dump

[protected]

Dump data if the dumper is valid

Parameters:
dataBuffer to dump
sentTrue if data is being sent, false if is being received
linkLink number (relevant to MTP2 only)

Returns: True if the data was dumped successfully

inline void  setDumpNetwork (bool network)

setDumpNetwork

[protected]

Set the dump network side flag

Parameters:
networkTrue to dump as network side, false othervise

void  setDumper (SignallingDumper* dumper = 0)

setDumper

[protected]

Set or remove the data dumper

Parameters:
dumperPointer to the data dumper object, 0 to remove

bool  setDumper (const String& name, bool create = true, bool append = false)

setDumper

[protected]

Set or remove a file data dumper

Parameters:
nameName of the file to dump to, empty to remove dumper
createTrue to create the file if doesn't exist
appendAppend 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

bool  control (NamedList& params, SignallingComponent* owner = 0)

control

[protected]

Handle dumper related control on behalf of the owning component

Parameters:
paramsControl parameters to handle
ownerOptional owning component

Returns: True if control operation was applied


Generated by: paulc on bussard on Tue Apr 12 17:15:21 2011, using kdoc 2.0a54.