CUpnpDlnaProtocolInfo Class Reference

class CUpnpDlnaProtocolInfo : public CUpnpProtocolInfo

UpnpDlnaProtocolInfo class.

upnpavobjects.lib
Since
S60 3.1

Inherits from

Public Member Functions
~CUpnpDlnaProtocolInfo ()
IMPORT_C TBool CiParameter ()
IMPORT_C TBool DlnaFlag ( UpnpDlnaProtocolInfo::TDlnaFlags )
IMPORT_C TPtrC8 FlagsParameterL ()
IMPORT_C TPtrC8 FourthField ()
void FourthParameterInternalL ()
TBool GetDlnaOpRangeParam ()
TBool GetDlnaOpTimeParam ()
TInt GetFourthParameterLength ()
IMPORT_C TPtrC8 GetOtherParams ()
IMPORT_C CUpnpDlnaProtocolInfo * NewL ()
IMPORT_C CUpnpDlnaProtocolInfo * NewL (const TDesC8 &)
IMPORT_C TBool OpParameter ( UpnpDlnaProtocolInfo::TDlnaParams )
IMPORT_C TPtrC8 OpParameterL ()
IMPORT_C TPtrC8 PnParameter ()
IMPORT_C TPtrC8 PsParameter ()
void SerializeDlnaFlagsL ( TDes8 &)
IMPORT_C void SetCiParameter ( TBool )
IMPORT_C void SetDlnaFlag ( UpnpDlnaProtocolInfo::TDlnaFlags , TBool )
IMPORT_C void SetFlagsParameterL (const TDesC8 &)
IMPORT_C void SetOpParameterL (const TDesC8 &)
IMPORT_C void SetOpParameterL ( UpnpDlnaProtocolInfo::TDlnaParams , TBool )
IMPORT_C void SetOtherParamL (const TDesC8 &)
IMPORT_C void SetPnParameterL (const TDesC8 &)
IMPORT_C void SetPsParameterL (const TDesC8 &)
Protected Member Functions
CUpnpDlnaProtocolInfo ()
void ConstructL (const TDesC8 &)
void GetFourthParameterInternalL ( TDes8 &)
TBool IsDlnaFlagsSet ()
void SetDlnaFlag ( TBool , TUint8 )
void SetOpRangeParam ( TBool )
void SetOpTimeParam ( TBool )
Private Member Functions
TBool GetDlnaFlag ( TInt )
TBool GetDlnaParam ( TInt )
void ParseDlnaCiParamL ( TLex8 &)
void ParseDlnaFlagsParamL ( TLex8 &)
void ParseDlnaOpParamL ( TLex8 &)
void ParseDlnaPnParamL ( TLex8 &)
void ParseDlnaPsParamL ( TLex8 &)
TBool ParseForthParameterInternalL (const TDesC8 &, TLex8 &)
TInt ParseForthParameterL ()
TInt ParseL (const TDesC8 &)
void ParseOtherParamsL ( TLex8 &)
void SetDlnaParam ( TBool , TUint8 )
void SetIntBit32 ( TUint32 &, TBool , TUint8 )
void SetIntBit8 ( TUint8 &, TBool , TUint8 )
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CUpnpProtocolInfo::BaseConstructL(const TDesC8 &)
CUpnpProtocolInfo::CUpnpProtocolInfo()
CUpnpProtocolInfo::CheckBooleanValue(TChar)
CUpnpProtocolInfo::FirstField()
CUpnpProtocolInfo::GetProtocolInfoLength()
CUpnpProtocolInfo::ParseAtomToDelimeter(TLex8 &,TChar)
CUpnpProtocolInfo::ProtocolInfoL()
CUpnpProtocolInfo::SecondField()
CUpnpProtocolInfo::SetFirstFieldL(const TDesC8 &)
CUpnpProtocolInfo::SetFourthFieldL(const TDesC8 &)
CUpnpProtocolInfo::SetParameterL(TInt,const TDesC8 &)
CUpnpProtocolInfo::SetSecondFieldL(const TDesC8 &)
CUpnpProtocolInfo::SetThirdFieldL(const TDesC8 &)
CUpnpProtocolInfo::Skip(TLex8 &,TInt)
CUpnpProtocolInfo::SkipAndMark(TLex8 &,TInt)
CUpnpProtocolInfo::ThirdField()
CUpnpProtocolInfo::~CUpnpProtocolInfo()
Protected Attributes
TInt iDlnaCi
TUint32 iDlnaFlags
HBufC8 * iDlnaPn
HBufC8 * iDlnaPs
HBufC8 * iFlagsParam
HBufC8 * iOpParam
HBufC8 * iOtherParams
TUint8 iParams
Inherited Attributes
CUpnpProtocolInfo::iFourthParameter
CUpnpProtocolInfo::iProtocolInfo
CUpnpProtocolInfo::iThirdParameter

Constructor & Destructor Documentation

CUpnpDlnaProtocolInfo()

CUpnpDlnaProtocolInfo ( ) [protected]

Constructor of the class

~CUpnpDlnaProtocolInfo()

~CUpnpDlnaProtocolInfo ( ) [virtual]

Destructor of the class.

Member Functions Documentation

CiParameter()

IMPORT_C TBool CiParameter ( )

Getter for DLNA.ORG_CI [ci-param-delim] "DLNA.ORG_CI=" ci-value ci-param-delim = ';' ci-value = Boolean Boolean = '0' | '1'

ConstructL(const TDesC8 &)

void ConstructL ( const TDesC8 & aInputString ) [protected]

Method for creating instance of class. aInputString must contain protocolInfo string.

Parameters

const TDesC8 & aInputString

DlnaFlag(UpnpDlnaProtocolInfo::TDlnaFlags)

IMPORT_C TBool DlnaFlag ( UpnpDlnaProtocolInfo::TDlnaFlags flag )

Getter for a single flag.

Parameters

UpnpDlnaProtocolInfo::TDlnaFlags flag

FlagsParameterL()

IMPORT_C TPtrC8 FlagsParameterL ( )

getter for DLNA.ORG_FLAGS "DLNA.ORG_FLAGS=" flags-value flags-value = primary-flags reserved-data primary-flags = 8 hexdigit reserved-data = 24 reserved-hexdigit hexdigit = <hexadecimal digit: '0' - '9', 'A' - 'F', 'a' - 'f'>, reserved-hexdigit = '0'

FourthField()

IMPORT_C TPtrC8 FourthField ( ) [virtual]

Getter for fourth parameter

FourthParameterInternalL()

void FourthParameterInternalL ( )

GetDlnaFlag(TInt)

TBool GetDlnaFlag ( TInt aFlagIndex ) [private]

Getter for DLNA_FLAGS

Parameters

TInt aFlagIndex

GetDlnaOpRangeParam()

TBool GetDlnaOpRangeParam ( )

Getter for DLNA.ORG_OP range seek parameter

GetDlnaOpTimeParam()

TBool GetDlnaOpTimeParam ( )

Getter for DLNA.ORG_OP time seek parameter.

GetDlnaParam(TInt)

TBool GetDlnaParam ( TInt aParamIndex ) [private]

Getter for Internal variable. Gets a bit from iParams byte, from aParamIndex position.

Parameters

TInt aParamIndex

GetFourthParameterInternalL(TDes8 &)

void GetFourthParameterInternalL ( TDes8 & aBuffer ) [protected, virtual]

This function produces a string containing all info taken from fourth ProtocolInfo field aBuffer - on this variable values are appended.

Parameters

TDes8 & aBuffer

GetFourthParameterLength()

TInt GetFourthParameterLength ( ) [virtual]

This function returns length of the string containing all relevant information from fourth ProtocolInfo field. Returns - length of the string for 4th field.

GetOtherParams()

IMPORT_C TPtrC8 GetOtherParams ( )

Getter for other parameter value. other-param = [other-param-delim] IANA-name '_' other-param-name '=' other-param-value other-param-delim = ';' IANA-name = <IANA-registered name, with top level domain (e.g. .net, .org, .com)> other-param-name = *<'a'-'z', 'A'-'Z', '0'-'9'>

IsDlnaFlagsSet()

TBool IsDlnaFlagsSet ( ) [protected]

This function returns ETrue if at least one dlna flag is set.

NewL()

IMPORT_C CUpnpDlnaProtocolInfo * NewL ( ) [static]

Factory method for creating instance of the class. aInputString must contain protocolInfo string.

NewL(const TDesC8 &)

IMPORT_C CUpnpDlnaProtocolInfo * NewL ( const TDesC8 & aInputString ) [static]

Factory method for creating instance of the class. aInputString must contain protocolInfo string.

Parameters

const TDesC8 & aInputString

OpParameter(UpnpDlnaProtocolInfo::TDlnaParams)

IMPORT_C TBool OpParameter ( UpnpDlnaProtocolInfo::TDlnaParams param )

Parameters

UpnpDlnaProtocolInfo::TDlnaParams param

OpParameterL()

IMPORT_C TPtrC8 OpParameterL ( )

Getter for DLNA.ORG_OP op-param = [op-param-delim] "DLNA.ORG_OP=" op-value op-param-delim = ';' op-value = a-val b-val a-val = Boolean b-val = Boolean, Boolean = '1' | '0'

ParseDlnaCiParamL(TLex8 &)

void ParseDlnaCiParamL ( TLex8 & aLexer ) [private]

Parses DLNA.ORG_CI params.

Parameters

TLex8 & aLexer

ParseDlnaFlagsParamL(TLex8 &)

void ParseDlnaFlagsParamL ( TLex8 & aLexer ) [private]

Parses DLNA.ORG_FLAGS params.

Parameters

TLex8 & aLexer

ParseDlnaOpParamL(TLex8 &)

void ParseDlnaOpParamL ( TLex8 & aLexer ) [private]

Parses DLNA.ORG_OP params.

Parameters

TLex8 & aLexer

ParseDlnaPnParamL(TLex8 &)

void ParseDlnaPnParamL ( TLex8 & aLexer ) [private]

Parses DLNA.ORG_PN params.

Parameters

TLex8 & aLexer

ParseDlnaPsParamL(TLex8 &)

void ParseDlnaPsParamL ( TLex8 & aLexer ) [private]

Parses DLNA.ORG_PS params.

Parameters

TLex8 & aLexer

ParseForthParameterInternalL(const TDesC8 &, TLex8 &)

TBool ParseForthParameterInternalL ( const TDesC8 & aName,
TLex8 & aLexer
) [private]

Parses the fourth parameter Returns: ETrue - When the last parameter has been parsed. EFalse - In other situations.

Parameters

const TDesC8 & aName
TLex8 & aLexer

ParseForthParameterL()

TInt ParseForthParameterL ( ) [private]

Parses the fourth parameter. Returns KErrNone when everything is ok. KErrArgument when additionalInfo string is empty.

ParseL(const TDesC8 &)

TInt ParseL ( const TDesC8 & aInputString ) [private, virtual]

Parses aInputString into protocolInfo object. aInputString- descriptor with protocolInfo Returns KErrNone when everything ok. KErrArgument when there was additionalInfo string empty.

Parameters

const TDesC8 & aInputString

ParseOtherParamsL(TLex8 &)

void ParseOtherParamsL ( TLex8 & aLexer ) [private]

Parses other params.

Parameters

TLex8 & aLexer

PnParameter()

IMPORT_C TPtrC8 PnParameter ( )

Getter for DLNA.ORG_PN pn-param= "DLNA.ORG_PN=" pn-value, where pn-value= *<'a'-'z', 'A'-'Z', '0'-'9', '_'>

PsParameter()

IMPORT_C TPtrC8 PsParameter ( )

Getter for DLNA.ORG_PS [ps-param-delim] "DLNA.ORG_PS=" ps-value ps-param-delim = ';', ps-value = [server-speed *(',' server-speed)] server-speed = <conforms to the TransportPlaySpeed string, as specified in the AVTransport specification>

SerializeDlnaFlagsL(TDes8 &)

void SerializeDlnaFlagsL ( TDes8 & aBuffer )

This member function serializes iDlnaFlags member variable into a string. aBuffer - variable to which iDlnaFlags will be appended.

Parameters

TDes8 & aBuffer

SetCiParameter(TBool)

IMPORT_C void SetCiParameter ( TBool aValue )

Setter for DLNA.ORG_CI

Parameters

TBool aValue

SetDlnaFlag(UpnpDlnaProtocolInfo::TDlnaFlags, TBool)

IMPORT_C void SetDlnaFlag ( UpnpDlnaProtocolInfo::TDlnaFlags flag,
TBool aValue
)

Setter for a single flag.

Parameters

UpnpDlnaProtocolInfo::TDlnaFlags flag
TBool aValue

SetDlnaFlag(TBool, TUint8)

void SetDlnaFlag ( TBool aValue,
TUint8 aFlagIndex
) [protected]

Setter for DLNA_FLAGS

Parameters

TBool aValue
TUint8 aFlagIndex

SetDlnaParam(TBool, TUint8)

void SetDlnaParam ( TBool aValue,
TUint8 aParamIndex
) [private]

Setter for Internal variable. Sets aValue on position specified by aBitNumber in iParams byte.

Parameters

TBool aValue
TUint8 aParamIndex

SetFlagsParameterL(const TDesC8 &)

IMPORT_C void SetFlagsParameterL ( const TDesC8 & flags )

setter for DLNA.ORG_FLAGS

Parameters

const TDesC8 & flags

SetIntBit32(TUint32 &, TBool, TUint8)

void SetIntBit32 ( TUint32 & aParameter,
TBool aValue,
TUint8 aBitNumber
) [private]

Setter for DLNA_FLAGS Sets aValue on position specified by aBitNumber in aParameter byte.

Parameters

TUint32 & aParameter
TBool aValue
TUint8 aBitNumber

SetIntBit8(TUint8 &, TBool, TUint8)

void SetIntBit8 ( TUint8 & aParameter,
TBool aValue,
TUint8 aBitNumber
) [private]

Setter for DLNA_FLAGS Sets in aParameter, aValue at aBitNumber counting from right.

Parameters

TUint8 & aParameter
TBool aValue
TUint8 aBitNumber

SetOpParameterL(const TDesC8 &)

IMPORT_C void SetOpParameterL ( const TDesC8 & aValue )

Setter for DLNA.ORG_OP

Parameters

const TDesC8 & aValue

SetOpParameterL(UpnpDlnaProtocolInfo::TDlnaParams, TBool)

IMPORT_C void SetOpParameterL ( UpnpDlnaProtocolInfo::TDlnaParams param,
TBool aValue
)

Setter for DLNA.ORG_OP

Parameters

UpnpDlnaProtocolInfo::TDlnaParams param
TBool aValue

SetOpRangeParam(TBool)

void SetOpRangeParam ( TBool aValue ) [protected]

Setter for DLNA.ORG_OP range seek parameter.

Parameters

TBool aValue

SetOpTimeParam(TBool)

void SetOpTimeParam ( TBool aValue ) [protected]

Setter for DLNA.ORG_OP time seek parameter.

Parameters

TBool aValue

SetOtherParamL(const TDesC8 &)

IMPORT_C void SetOtherParamL ( const TDesC8 & aValue )

Setter for other parameter. Refer

Parameters

const TDesC8 & aValue

SetPnParameterL(const TDesC8 &)

IMPORT_C void SetPnParameterL ( const TDesC8 & aValue )

Setter for DLNA.ORG_PN

Parameters

const TDesC8 & aValue

SetPsParameterL(const TDesC8 &)

IMPORT_C void SetPsParameterL ( const TDesC8 & aValue )

Setter for DLNA.ORG_PS

Parameters

const TDesC8 & aValue

Member Data Documentation

TInt iDlnaCi

TInt iDlnaCi [protected]

It contains values of DLNA.ORG_CI parameter.

TUint32 iDlnaFlags

TUint32 iDlnaFlags [protected]

This contains flags, which are DLNA.ORG_FLAGS parameter value TUnit32[0] This main flags field contains: 31-bit ... 0-bit where: Values stored in enum: DLNA_FLAGS. 31-bit SP_FLAG Sender Paced flag. 30-bit LSOP_TSR_FLAG limited time seek flag 29-bit LSOP_RANGE_FLAG limited range seek flag 28-bit PLAY_CONTAINER play container flag 27-bit S0_INC_FLAG S0 increasing flag. 26-bit SN_INC_FLAG SN increasing flag ... Unused TUint32[1], TUint32[2], TUint32[3], there is no method to access this members. this might be used in inherited classes.

HBufC8 * iDlnaPn

HBufC8 * iDlnaPn [protected]

If not null, it contains values of DLNA.ORG_PN parameter.

HBufC8 * iDlnaPs

HBufC8 * iDlnaPs [protected]

If not null, it contains values of DLNA.ORG_PS parameter. There is no additional support for this parameter.

HBufC8 * iFlagsParam

HBufC8 * iFlagsParam [protected]

HBufC8 * iOpParam

HBufC8 * iOpParam [protected]

HBufC8 * iOtherParams

HBufC8 * iOtherParams [protected]

String containing information about other parameters from DLNA specification. In case of this is not DLNA protocolInfo, it contains information about whole 4th field.

TUint8 iParams

TUint8 iParams [protected]

There are stored binary parameters from DLNA specification in this member. 7-bit 0-bit 7-bit this is LSOP Time parameter from DLNA.ORG_OP 6-bit this is LSOP Range parameter from DLNA.ORG_OP 5-bit this is CI parameter DLNA.ORG_CI There is a enum containing this information: DLNA_PARAMS