DtvKit_ATSC3.0
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
CAtscMw Class Reference

#include <atsc_mw.h>

Public Member Functions

 CAtscMw ()
 Constructor of CAtscMw.
 
 ~CAtscMw ()
 Destructor for CAtscMw.
 
int32_t GetSupportedStandards (void)
 read supported standards
 
int32_t GetAvailNoOfFrontendInstances (void)
 returns available number of frontend instances
 
eATSCResult_t SetRegion (eRegion_t iRegion)
 Set region:Default :US.
 
eRegion_t GetRegion (void)
 returns current region ID
 
eATSCResult_t SetDemod (eDemod_t iDemod)
 Set Demod type :Default :ATSC3.0.
 
eDemod_t GetDemod (void)
 returns current Demod ID
 
eATSCResult_t TuneToChannel (int32_t iId, int32_t iCh, int32_t iPlp, eDemod_t iDemod, eRegion_t iRegion)
 
eATSCResult_t TuneToChannel (int32_t iId, int32_t iCh, int32_t iPlp)
 
eATSCResult_t ScanChannels (int32_t iTunerId, int32_t iStartCh, int32_t iEndCh, int32_t iDemod, int32_t iPlpId)
 
eATSCResult_t ScanChannels (int32_t iId, int32_t iStartCh, int32_t iEndCh, int32_t iPlp, eDemod_t iDemod, eRegion_t iRegion)
 
eATSCResult_t StopChannelScan (int32_t iId)
 Stop channel scan.
 
eATSCResult_t StartFrontend (int32_t iId)
 Start frontend functionality.
 
eATSCResult_t StopFrontend (int32_t iId)
 Stop frontend functionality.
 
eATSCResult_t GetFrontendProps (int32_t iId, sFeProp_t *pParams)
 Read frontend properties.
 
eATSCResult_t GetFrontendStatus (int32_t iId, sFeStatus_t *pStatus)
 Read frontend status.
 
eATSCResult_t RegisterFrontendStatusCbEvents (FeStatusCbFunc fstatus)
 Register frontend status callback.
 
eATSCResult_t RegisterFrontendParamCbEvents (FeParamsCbFunc ptrfunc)
 Register frontend params callback.
 
sServiceListTable_t GetSltData (void)
 Get slt data.
 
std::string GetSystemTime (void)
 To get read system time.
 
sRrtDataTable_t GetRrt (void)
 To get read system time.
 
void RegisterOnsnMsgEventNotify (OnScreenNotify fParamsPtr)
 Notification event for on screen message.
 
std::string GetMwGuideInfo (char *pUri)
 Get Guide display Info.
 
std::string GetMwTunerInfo (sFeStatus_t *pStatus, int32_t iTunerId)
 Get Tuner Info.
 
std::string GetMwTunersInfo (void)
 Get Tuner Info.
 
std::string GetQueryHttpResponse (std::string sContentData)
 Get Http Response.
 
std::string GetVersion (char *pFwVersion)
 read version
 
std::string GetMwPrepareTunerInfo (void)
 Tuner info string to display.
 
std::string GetDumpHistory (void)
 Display dump histroy.
 
std::string RequestService (std::string sUri, char *pContentData)
 Request tuner service.
 
std::string RequestDump (std::string sUri, int32_t iType)
 Request dump info.
 
std::string RequestTuners (std::string sUri, char *pContentData)
 Request tuner service.
 
std::string RequestUserService (std::string sUri, char *pContentData)
 
std::string RequestScan (std::string sUri, char *pContentData)
 Request Scan service.
 
std::list< sScanResult_tGetScanningResult (void)
 Get the scanning result.
 
void CancelChannelScan (void)
 Stop the scanning process.
 
int32_t Start (int32_t iPort)
 Creates a new thread to handle server operations.
 
void ThreadServer (void *pArg, int32_t iPort)
 For handling incoming connections and managing the server socket.
 
void Connection (int32_t iClientSock, struct sockaddr_in *pClientAddr, socklen_t stClientAddrLen)
 Handling an incoming client connection. It reads the HTTP header from the client determines the HTTP method, parses the header.
 
int32_t ParserHttpProtocol (eHttpType_t eHttpType, int32_t iSock, sHttpHeader_t stHttpHeader)
 Parses and processes HTTP requests based on their type(GET, POST, PUT, DELETE).
 
std::string ParserHttpProtocolFromNative (int32_t iTunerId, int32_t iType, int32_t iSock, sHttpHeader_t stHttpHeader)
 Parses and processes HTTP requests based on their type(GET, POST, PUT, DELETE) via native application.
 
void Join (void)
 Waits for the API server thread to finish and cleans up resources.
 
std::string GetFrontendConfiguration (void)
 Get the tuner related configuration.
 

Public Attributes

std::thread * mServerThread =nullptr
 
bool mRunning
 

Detailed Description

CAtscMw

Constructor & Destructor Documentation

◆ CAtscMw()

CAtscMw::CAtscMw ( )

Constructor of CAtscMw.

Parameters
N/A
Return values
N/A

◆ ~CAtscMw()

CAtscMw::~CAtscMw ( )

Destructor for CAtscMw.

Parameters
N/A
Return values
N/A

Member Function Documentation

◆ CancelChannelScan()

CAtscMw::CancelChannelScan ( void )

Stop the scanning process.

Parameters
NA
Return values
NA

◆ Connection()

CAtscMw::Connection ( int32_t iClientSock,
struct sockaddr_in * pClientAddr,
socklen_t stClientAddrLen )

Handling an incoming client connection. It reads the HTTP header from the client determines the HTTP method, parses the header.

Parameters
iClientSock,sockaddr_in*pClientAddr,socklen_t iClientAddrLen
Return values
void

◆ GetAvailNoOfFrontendInstances()

CAtscMw::GetAvailNoOfFrontendInstances ( void )

returns available number of frontend instances

Parameters
None
Return values
Availablenumber of Frontend instances

◆ GetDemod()

CAtscMw::GetDemod ( void )

returns current Demod ID

Parameters
None
Return values
eDemod_t

◆ GetDumpHistory()

CAtscMw::GetDumpHistory ( void )

Display dump histroy.

Parameters
void
Return values
std::string

◆ GetFrontendConfiguration()

CAtscMw::GetFrontendConfiguration ( void )

Get the tuner related configuration.

Parameters
NA
Return values
std::string

◆ GetFrontendProps()

CAtscMw::GetFrontendProps ( int32_t iId,
sFeProp_t * pParams )

Read frontend properties.

Parameters
iId:Frontend Id , pParams:sFeProp_t structure pointer
Return values
eATSCResult_t

◆ GetFrontendStatus()

CAtscMw::GetFrontendStatus ( int32_t iId,
sFeStatus_t * pStatus )

Read frontend status.

Parameters
iId:Frontend Id , pParams:sFeStatus_t structure pointer
Return values
eATSCResult_t

◆ GetMwGuideInfo()

CAtscMw::GetMwGuideInfo ( char * pUri)

Get Guide display Info.

Parameters
Uristring for display
Return values
std::string

◆ GetMwPrepareTunerInfo()

CAtscMw::GetMwPrepareTunerInfo ( void )

Tuner info string to display.

Parameters
void
Return values
std::string

◆ GetMwTunerInfo()

CAtscMw::GetMwTunerInfo ( sFeStatus_t * pStatus,
int32_t iTunerId )

Get Tuner Info.

Parameters
sFeStatus_t*pStatus,int32_t iTunerId
Return values
std::string

◆ GetMwTunersInfo()

CAtscMw::GetMwTunersInfo ( void )

Get Tuner Info.

Parameters
void
Return values
std::string

◆ GetQueryHttpResponse()

CAtscMw::GetQueryHttpResponse ( std::string sContentData)

Get Http Response.

Parameters
std::stringsContentData
Return values
std::string

◆ GetRegion()

CAtscMw::GetRegion ( void )

returns current region ID

Parameters
None
Return values
eRegion_t

◆ GetRrt()

CAtscMw::GetRrt ( void )

To get read system time.

Parameters
N/A
Return values
sRrtDataTable_t

◆ GetScanningResult()

CAtscMw::GetScanningResult ( void )

Get the scanning result.

Parameters
NA
Return values
std::list<sScanResult_t>

◆ GetSltData()

CAtscMw::GetSltData ( void )

Get slt data.

Parameters
None
Return values
sServiceListTable_t

◆ GetSupportedStandards()

CAtscMw::GetSupportedStandards ( void )

read supported standards

Parameters
None
Return values
or'edvalues of supported standards

◆ GetSystemTime()

CAtscMw::GetSystemTime ( void )

To get read system time.

Parameters
N/A
Return values
std::string

◆ GetVersion()

CAtscMw::GetVersion ( char * pFwVersion)

read version

Parameters
char*pFwVersion
Return values
std::string

◆ Join()

CAtscMw::Join ( void )

Waits for the API server thread to finish and cleans up resources.

Parameters
NA
Return values
void

◆ ParserHttpProtocol()

CAtscMw::ParserHttpProtocol ( eHttpType_t eHttpType,
int32_t iSock,
sHttpHeader_t stHttpHeader )

Parses and processes HTTP requests based on their type(GET, POST, PUT, DELETE).

Parameters
eHttpType_teType,iSock,sHttpHeader_t stHttpHeader
Return values
int32_t

◆ ParserHttpProtocolFromNative()

CAtscMw::ParserHttpProtocolFromNative ( int32_t iTunerId,
int32_t iType,
int32_t iSock,
sHttpHeader_t stHttpHeader )

Parses and processes HTTP requests based on their type(GET, POST, PUT, DELETE) via native application.

Parameters
int32_tiTunerId , int32_t iType ,int32_t iSock, sHttpHeader_t stHttpHeader
Return values
std::string

◆ RegisterFrontendParamCbEvents()

CAtscMw::RegisterFrontendParamCbEvents ( FeParamsCbFunc ptrfunc)

Register frontend params callback.

Parameters
FeParamsCbFuncptrfunc
Return values
eATSCResult_t

◆ RegisterFrontendStatusCbEvents()

CAtscMw::RegisterFrontendStatusCbEvents ( FeStatusCbFunc fstatus)

Register frontend status callback.

Parameters
FeStatusCbFuncfstatus
Return values
eATSCResult_t

◆ RegisterOnsnMsgEventNotify()

CAtscMw::RegisterOnsnMsgEventNotify ( OnScreenNotify fParamsPtr)

Notification event for on screen message.

Parameters
notifycall back
Return values
void

◆ RequestDump()

CAtscMw::RequestDump ( std::string sUri,
int32_t iType )

Request dump info.

Parameters
std::stringsUri,int32_t iType
Return values
std::string

◆ RequestScan()

CAtscMw::RequestScan ( std::string sUri,
char * pContentData )

Request Scan service.

Parameters
std::stringsUri, char *pContentData
Return values
std::string

◆ RequestService()

CAtscMw::RequestService ( std::string sUri,
char * pContentData )

Request tuner service.

Parameters
std::stringsUri, char *pContentData
Return values
std::string

◆ RequestTuners()

CAtscMw::RequestTuners ( std::string sUri,
char * pContentData )

Request tuner service.

Parameters
std::stringsUri, char *pContentData
Return values
std::string

◆ SetDemod()

CAtscMw::SetDemod ( eDemod_t iDemod)

Set Demod type :Default :ATSC3.0.

Parameters
iDemodId
Return values
eATSCResult_t

◆ SetRegion()

CAtscMw::SetRegion ( eRegion_t iRegion)

Set region:Default :US.

Parameters
iRegionId
Return values
eATSCResult_t

◆ Start()

CAtscMw::Start ( int32_t iPort)

Creates a new thread to handle server operations.

Parameters
int32_tiPort
Return values
int32_t

◆ StartFrontend()

CAtscMw::StartFrontend ( int32_t iId)

Start frontend functionality.

Parameters
iId: Frontend Id
Return values
eATSCResult_t

◆ StopChannelScan()

CAtscMw::StopChannelScan ( int32_t iId)

Stop channel scan.

Parameters
iId:Frontend Id
Return values
eATSCResult_t

◆ StopFrontend()

CAtscMw::StopFrontend ( int32_t iId)

Stop frontend functionality.

Parameters
iId:Frontend Id
Return values
eATSCResult_t

◆ ThreadServer()

CAtscMw::ThreadServer ( void * pArg,
int32_t iPort )

For handling incoming connections and managing the server socket.

Parameters
void*pArg, int32_t iPort
Return values
void

Member Data Documentation

◆ mRunning

bool CAtscMw::mRunning

mRunning

◆ mServerThread

std::thread* CAtscMw::mServerThread =nullptr

mServerThread


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