CSessionBuf Class Reference

#include <atsc_core_atsc3_route_dashbuflist.h>

Public Member Functions
	CSessionBuf (uint32_t iCategory, uint32_t iTsi, char *pBase)
	Constructs a new CSessionBuf object. More...
	~CSessionBuf ()
	Deconstructs a CSessionBuf object. More...
void	SetHandler (funcDone fn1)
	Sets the handler function. More...
int32_t	Clear (void)
	Close the file and clear the data. More...
uint32_t	GetLen (uint32_t iToi)
	Retrieves the length associated with the specified identifier from the data vector. More...
uint32_t	GetSize (uint32_t iToi)
	Retrieves the size associated with the specified identifier from the data vector. More...
int32_t	WriteData (uint32_t iToi, uint8_t *pData, int32_t iDataLen)
	Writes data to the specified identifier in the session buffer. More...
int32_t	SetDefaultProperties (char *pMimeType, int32_t iBandwidth, int32_t iDuration, int32_t iTimescale)
	Copied the Mimetype. More...
int32_t	SetDefaultName (uint32_t iInitToi, char *pInitialization, char *pMedia)
	Sets default names for initialization and media associated with the session buffer. More...
int32_t	OpenFile (uint32_t iToi, uint32_t iLength, char *pFolder, char *pContentName, char *pContentEncoding)
	Opens a file associated with the specified identifier in the session buffer. More...
int32_t	CloseFile (uint32_t iToi)
	Closes the file associated with the specified identifier in the session buffer. If the file is successfully closed, the appropriate callback function is called. More...
int32_t	CleanUp (uint32_t iToi)
	Cleans up temporary files associated with the session buffer. More...
uint32_t	GetSessionId (void)
	Return the Session ID. More...
void	SetInfo (sTransportSessionId_t info)
	Copy the session data. More...
std::vector< sSessionFileProperties_t >	GetRecvInfo ()
	Return Data vector properties. More...
sTransportSessionId_t	GetInfo (void)
	Return the session data. More...
int32_t	GetCodePoint (void)
	Return CodePoint value. More...
uint32_t	GetInitToi (void)
	Return the Initial TOI value. More...

Public Attributes
funcDone	mCbDone

Detailed Description

CSessionBuf

Constructor & Destructor Documentation

CSessionBuf()

CSessionBuf::CSessionBuf	(	uint32_t	iCategory,
		uint32_t	iTsi,
		char *	pBase
	)

Constructs a new CSessionBuf object.

Parameters

iCategory,iTsi,char

*pBase

Return values

NA

~CSessionBuf()

CSessionBuf::~CSessionBuf

(

)

Deconstructs a CSessionBuf object.

Parameters

NA

Return values

NA

Member Function Documentation

CleanUp()

CSessionBuf::CleanUp

(

uint32_t

iToi

)

Cleans up temporary files associated with the session buffer.

Parameters

iToi

Return values

int32_t

Clear()

CSessionBuf::Clear

(

void

)

Close the file and clear the data.

Parameters

NA

Return values

int32_t

CloseFile()

CSessionBuf::CloseFile

(

uint32_t

iToi

)

Closes the file associated with the specified identifier in the session buffer. If the file is successfully closed, the appropriate callback function is called.

Parameters

iToi

Return values

int32_t

GetCodePoint()

CSessionBuf::GetCodePoint

(

void

)

Return CodePoint value.

Parameters

NA

Return values

int32_t

GetInfo()

CSessionBuf::GetInfo

(

void

)

Return the session data.

Parameters

NA

Return values

sTransportSessionId_t

GetInitToi()

CSessionBuf::GetInitToi

(

void

)

Return the Initial TOI value.

Parameters

NA

Return values

uint32_t

GetLen()

CSessionBuf::GetLen

(

uint32_t

iToi

)

Retrieves the length associated with the specified identifier from the data vector.

Parameters

iToi

Return values

uint32_t

GetRecvInfo()

CSessionBuf::GetRecvInfo

(

)

Return Data vector properties.

Parameters

NA

Return values

std::vector<sSessionFileProperties_t>

GetSessionId()

CSessionBuf::GetSessionId

(

void

)

Return the Session ID.

Parameters

NA

Return values

uint32_t

GetSize()

CSessionBuf::GetSize

(

uint32_t

iToi

)

Retrieves the size associated with the specified identifier from the data vector.

Parameters

iToi

Return values

uint32_t

OpenFile()

CSessionBuf::OpenFile	(	uint32_t	iToi,
		uint32_t	iLength,
		char *	pFolder,
		char *	pContentName,
		char *	pContentEncoding
	)

Opens a file associated with the specified identifier in the session buffer.

Parameters

iToi,iLength,pFolder,pContentName,pContentEncoding

Return values

int32_t

SetDefaultName()

CSessionBuf::SetDefaultName	(	uint32_t	iInitToi,
		char *	pInitialization,
		char *	pMedia
	)

Sets default names for initialization and media associated with the session buffer.

Parameters

iInitToi,pInitialization,pMedia

Return values

int32_t

SetDefaultProperties()

CSessionBuf::SetDefaultProperties	(	char *	pMimeType,
		int32_t	iBandwidth,
		int32_t	iDuration,
		int32_t	iTimescale
	)

Copied the Mimetype.

Parameters

pMimeType,iBandwidth,iDuration,iTimescale

Return values

int32_t

SetHandler()

CSessionBuf::SetHandler

(

funcDone

fn1

)

Sets the handler function.

Parameters

funcDone

fn1

Return values

void

SetInfo()

CSessionBuf::SetInfo

(

sTransportSessionId_t

info

)

Copy the session data.

Parameters

sTransportSessionId_t

info

Return values

void

WriteData()

CSessionBuf::WriteData	(	uint32_t	iToi,
		uint8_t *	pData,
		int32_t	iDataLen
	)

Writes data to the specified identifier in the session buffer.

Parameters

iToi,pData,iDataLen

Return values

int32_t

---

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

• /home/nick/DTVKit/ATSC3/src/atsc/core/src/atsc3/route/atsc_core_atsc3_route_dashbuflist.h
• /home/nick/DTVKit/ATSC3/src/atsc/core/src/atsc3/route/atsc_core_atsc3_route_dashbuflist.cpp