CDump Class Reference

#include <atsc_core_utils_dump_api.h>

Public Member Functions
	CDump ()
	Constructor of CDump. More...
	~CDump ()
	Deconstructor of CDump. More...
void	SetCallback (void *pCtx, void *pFunc)
	Set the callback_mGetInfo callback. More...
int32_t	Clear (void)
	Clears the dump list and deletes all dump files. More...
std::string	GetHistory (void)
	Retrieves the history of dump operations in JSON format. More...
int32_t	Save (void)
	Saves the dump list to a JSON file. More...
int32_t	Load (void)
	Loads dump information from a JSON file. More...
bool	is_dumping (int32_t iId)
	Dump inprogress or not. More...
bool	is_enable (int32_t iId)
	Whether the dump is enable. More...
FILE *	get_file (int32_t iId)
	Get the dump file. More...
timespec	get_starttime (int32_t iId)
	Get time related info. More...
int32_t	get_sec (int32_t iId)
	Get Seconds for dump request. More...
int32_t	Put (int32_t iId, unsigned char *pData, int32_t iSize)
	Adds data to the specified dump request. More...
int32_t	Start (sDumpReq_t req)
	Starts a dump operation. More...
int32_t	Stop (int32_t iId)
	Stops a dump operation and records dump information. More...
std::string	ReqResponse (sDumpReq_t req)
	Generates a JSON response for a dump request. More...

Public Attributes
std::list< sDumpInfo_t >	mDumpList
sDumpReq_t	mDumpReq [ATSCCORE_FRONTEND_MAX]

Detailed Description

CDump

Constructor & Destructor Documentation

CDump()

CDump::CDump

(

)

Constructor of CDump.

Parameters

N/A

Return values

N/A

~CDump()

CDump::~CDump

(

)

Deconstructor of CDump.

Parameters

N/A

Return values

N/A

Member Function Documentation

Clear()

CDump::Clear

(

void

)

Clears the dump list and deletes all dump files.

Parameters

N/A

Return values

int32_t

get_file()

CDump::get_file ( int32_t  iId )

inline

Get the dump file.

Parameters

int32_t

iId

Return values

FILE*

get_sec()

CDump::get_sec ( int32_t  iId )

inline

Get Seconds for dump request.

Parameters

int32_t

iId

Return values

int32_t

get_starttime()

CDump::get_starttime ( int32_t  iId )

inline

Get time related info.

Parameters

int32_t

iId

Return values

timespec

GetHistory()

CDump::GetHistory

(

void

)

Retrieves the history of dump operations in JSON format.

Parameters

N/A

Return values

std::string

is_dumping()

CDump::is_dumping ( int32_t  iId )

inline

Dump inprogress or not.

Parameters

int32_t

iId

Return values

bool

is_enable()

CDump::is_enable ( int32_t  iId )

inline

Whether the dump is enable.

Parameters

int32_t

iId

Return values

bool

Load()

CDump::Load

(

void

)

Loads dump information from a JSON file.

Parameters

N/A

Return values

int32_t

Put()

CDump::Put ( int32_t  iId, unsigned char *  pData, int32_t  iSize  )

inline

Adds data to the specified dump request.

Parameters

int32_t

iId, unsigned char *pData, int32_t iSize

Return values

int32_t

ReqResponse()

CDump::ReqResponse

(

sDumpReq_t

req

)

Generates a JSON response for a dump request.

Parameters

sDumpReq_t

req

Return values

std::string

Save()

CDump::Save

(

void

)

Saves the dump list to a JSON file.

Parameters

N/A

Return values

int32_t

SetCallback()

CDump::SetCallback ( void *  pCtx, void *  pFunc  )

inline

Set the callback_mGetInfo callback.

Parameters

void*

pCtx, void* pFunc

Return values

NA

Start()

CDump::Start

(

sDumpReq_t

req

)

Starts a dump operation.

Parameters

sDumpReq_t

req

Return values

int32_t

Stop()

CDump::Stop

(

int32_t

iId

)

Stops a dump operation and records dump information.

Parameters

int32_t

iId

Return values

int32_t

Member Data Documentation

mDumpReq

sDumpReq_t CDump::mDumpReq[ATSCCORE_FRONTEND_MAX]

mDumpReq

---

The documentation for this class was generated from the following files:

• /home/nick/DTVKit/ATSC3/src/atsc/core/src/utils/dump/atsc_core_utils_dump_api.h
• /home/nick/DTVKit/ATSC3/src/atsc/core/src/utils/dump/atsc_core_utils_dump_api.cpp