Class for the Drm Metadata event. More...

#include <AampEvent.h>

Inheritance diagram for DrmMetaDataEvent:

Collaboration diagram for DrmMetaDataEvent:

Public Member Functions
	DrmMetaDataEvent (const DrmMetaDataEvent &)=delete

DrmMetaDataEvent &	operator= (const DrmMetaDataEvent &)=delete

	DrmMetaDataEvent (AAMPTuneFailure failure, const std::string &accessStatus, int statusValue, long responseCode, bool secclientErr)
	DrmMetaDataEvent Constructor.

virtual	~DrmMetaDataEvent ()
	DrmMetaDataEvent Destructor.

AAMPTuneFailure	getFailure () const
	Get Failure type. More...

void	setFailure (AAMPTuneFailure failure)
	Set Failure type. More...

const std::string &	getAccessStatus () const
	Get Access Status. More...

void	setAccessStatus (const std::string &status)
	Set Access Status. More...

int	getAccessStatusValue () const
	Get Access Status. More...

void	setAccessStatusValue (int value)
	Set Access Status Value. More...

long	getResponseCode () const
	Get Response Code. More...

int32_t	getSecManagerReasonCode () const
	Get Response Code. More...

int32_t	getSecManagerClassCode () const
	Get Response Code. More...

int32_t	getBusinessStatus () const
	Get Response Code. More...

void	setResponseCode (long code)
	Set Response Code. More...

void	setSecManagerReasonCode (int32_t code)
	Get Secmanager response code. More...

bool	getSecclientError () const
	Get secclient error status. More...

void	setSecclientError (bool secclientError)
	Set secclient error status. More...

void	SetVerboseErrorCode (int32_t statusCode, int32_t reasonCode, int32_t businessStatus)
	Set the secmanager DRM error responses.

void	ConvertToVerboseErrorCode (int32_t httpCode, int32_t httpExtStatusCode)
	Convert the secclient DRM error code into secmanager error code to have a unified verbose error reported.

Public Member Functions inherited from AAMPEventObject
	AAMPEventObject (const AAMPEventObject &)=delete
	Copy constructor disabled. More...

AAMPEventObject &	operator= (const AAMPEventObject &)=delete
	assignment operator disabled More...

	AAMPEventObject (AAMPEventType type)
	AAMPEventObject Constructor.

virtual	~AAMPEventObject ()
	AAMPEvent Destructor.

AAMPEventType	getType () const
	Get Event Type. More...

Private Attributes
AAMPTuneFailure	mFailure

std::string	mAccessStatus

int	mAccessStatusValue

long	mResponseCode

bool	mSecclientError

int32_t	mSecManagerClass

int32_t	mSecManagerReasonCode

int32_t	mBusinessStatus

yes

Class for the Drm Metadata event.

Definition at line 1396 of file AampEvent.h.

Member Function Documentation

◆ getFailure()

AAMPTuneFailure DrmMetaDataEvent::getFailure ( ) const

Get Failure type.

Returns: Tune failure type

Definition at line 872 of file AampEvent.cpp.

◆ setFailure()

void DrmMetaDataEvent::setFailure ( AAMPTuneFailure failure )

Set Failure type.

Parameters

[in] failure - Failure type

Returns: void

Definition at line 880 of file AampEvent.cpp.

◆ getAccessStatus()

const std::string & DrmMetaDataEvent::getAccessStatus ( ) const

Get Access Status.

Returns: Access status string

Definition at line 890 of file AampEvent.cpp.

◆ setAccessStatus()

void DrmMetaDataEvent::setAccessStatus ( const std::string & status )

Set Access Status.

Parameters

[in] status - Access status

Returns: void

Definition at line 898 of file AampEvent.cpp.

◆ getAccessStatusValue()

int DrmMetaDataEvent::getAccessStatusValue ( ) const

Get Access Status.

Returns: Access status value

Definition at line 908 of file AampEvent.cpp.

◆ setAccessStatusValue()

void DrmMetaDataEvent::setAccessStatusValue ( int value )

Set Access Status Value.

Parameters

[in] value - Access status value

Returns: void

Definition at line 916 of file AampEvent.cpp.

◆ getResponseCode()

long DrmMetaDataEvent::getResponseCode ( ) const

Get Response Code.

Returns: Response code

Definition at line 926 of file AampEvent.cpp.

◆ getSecManagerReasonCode()

int32_t DrmMetaDataEvent::getSecManagerReasonCode ( ) const

Get Response Code.

Returns: Response code

Definition at line 936 of file AampEvent.cpp.

◆ getSecManagerClassCode()

int32_t DrmMetaDataEvent::getSecManagerClassCode ( ) const

Get Response Code.

Returns: Response code

Definition at line 946 of file AampEvent.cpp.

◆ getBusinessStatus()

int32_t DrmMetaDataEvent::getBusinessStatus ( ) const

Get Response Code.

Returns: Response code

Definition at line 956 of file AampEvent.cpp.

◆ setResponseCode()

void DrmMetaDataEvent::setResponseCode ( long code )

Set Response Code.

Parameters

[in] code - Response code

Returns: void

Definition at line 964 of file AampEvent.cpp.

◆ setSecManagerReasonCode()

void DrmMetaDataEvent::setSecManagerReasonCode ( int32_t code )

Get Secmanager response code.

Set Secmanager response code.

Parameters

[string] code - secmanager reason code

Returns: Response code

Definition at line 972 of file AampEvent.cpp.

◆ getSecclientError()

bool DrmMetaDataEvent::getSecclientError ( ) const

Get secclient error status.

Returns: secclient error (true/false)

Definition at line 1017 of file AampEvent.cpp.

◆ setSecclientError()

void DrmMetaDataEvent::setSecclientError ( bool secclientError )

Set secclient error status.

Parameters

[in] sec client error status (true/false)

Returns: void

Definition at line 1025 of file AampEvent.cpp.

Field Documentation

◆ mFailure

AAMPTuneFailure DrmMetaDataEvent::mFailure

private

Error Type

Definition at line 1398 of file AampEvent.h.

◆ mAccessStatus

std::string DrmMetaDataEvent::mAccessStatus

private

Access status

Definition at line 1399 of file AampEvent.h.

◆ mAccessStatusValue

int DrmMetaDataEvent::mAccessStatusValue

private

Access status value

Definition at line 1400 of file AampEvent.h.

◆ mResponseCode

long DrmMetaDataEvent::mResponseCode

private

Response code

Definition at line 1401 of file AampEvent.h.

◆ mSecclientError

bool DrmMetaDataEvent::mSecclientError

private

Is secclient error

Definition at line 1402 of file AampEvent.h.

◆ mSecManagerClass

int32_t DrmMetaDataEvent::mSecManagerClass

private

Secmanager error class

Definition at line 1404 of file AampEvent.h.

◆ mSecManagerReasonCode

int32_t DrmMetaDataEvent::mSecManagerReasonCode

private

Secmanager reason code

Definition at line 1405 of file AampEvent.h.

◆ mBusinessStatus

int32_t DrmMetaDataEvent::mBusinessStatus

private

secclient business reason code

Definition at line 1406 of file AampEvent.h.

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

components/generic/aamp/AampEvent.h
components/generic/aamp/AampEvent.cpp
components/generic/aamp/test/utests/fakes/FakeAampEvent.cpp

Public Member Functions

Private Attributes

yes

Member Function Documentation

◆ getFailure()

◆ setFailure()

◆ getAccessStatus()

◆ setAccessStatus()

◆ getAccessStatusValue()

◆ setAccessStatusValue()

◆ getResponseCode()

◆ getSecManagerReasonCode()

◆ getSecManagerClassCode()

◆ getBusinessStatus()

◆ setResponseCode()

◆ setSecManagerReasonCode()

◆ getSecclientError()

◆ setSecclientError()

Field Documentation

◆ mFailure

◆ mAccessStatus

◆ mAccessStatusValue

◆ mResponseCode

◆ mSecclientError

◆ mSecManagerClass

◆ mSecManagerReasonCode

◆ mBusinessStatus