class SignallingDumper

A generic data dumper. More...

Full nameTelEngine::SignallingDumper
Definition#include <libs/ysig/yatesig.h>
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods

Public Static Methods


Detailed Description

This class is a generic data dumper with libpcap compatibility

enum Type { Raw, Hexa, Hdlc, Q921, Q931, Mtp2, Mtp3, Sccp, }

Type

Type of dumper output

 SignallingDumper (Type type = Hexa, bool network = false)

SignallingDumper

Constructor

Parameters:
typeType of the output desired
networkTrue if we are the network side of the link

 ~SignallingDumper ()

~SignallingDumper

Destructor, closes the output

inline Type  type ()

type

[const]

Get the type of the dumper

Returns: Type of the dumper object

inline bool  network ()

network

[const]

Get the network side flag

Returns: True if we are the network side

bool  active ()

active

[const]

Check if the dumper is active

Returns: True if the object will actually send data to something

void  terminate ()

terminate

Terminate the dump session, close the output

void  setStream (Stream* stream = 0, bool writeHeader = true)

setStream

Set a new output stream

Parameters:
streamNew stream for output, NULL to terminate
writeHeaderTrue to write the header (if any) at start of stream

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

dump

Dump the provided data

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

Dump the provided data

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

SignallingDumper*  create (DebugEnabler* dbg, const char* filename, Type type, bool network = false, bool create = true, bool append = false)

create

[static]

Create a file to dump data in it. The file is opened/created in write only, binary mode

Parameters:
dbgDebugEnabler requesting the operation (used for debug message on failure)
filenameThe file name to use
typeThe dumper type
networkTrue to create a network side 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: SignallingDumper pointer on success, 0 on failure

SignallingDumper*  create (Stream* stream, Type type, bool network = false, bool writeHeader = true)

create

[static]

Create a dumper from an already existing stream

Parameters:
streamStream to use for output, will be owned by dumper
typeThe dumper type
networkTrue to create a network side dumper
writeHeaderTrue to write the header (if any) at start of stream

Returns: SignallingDumper pointer on success, 0 on failure


Generated by: paulc on bussard on Thu Jul 24 18:41:02 2014, using kdoc 2.0a54.