Collapse all Symbian^3 Product Developer Library

CSenHttpTransportProperties Class Reference

class CSenHttpTransportProperties : public CSenTransportProperties

In SendL(CSenSoapEnvelope& aMessage, const TDesC8& aProperties) or SubmitL(CSenSoapEnvelope& aMessage, const TDesC8& aProperties, HBufc8*& aResponseTO) aProperties could be "HTTP GET" or "HTTP DELETE" aMessage is a soap message or serialized XML. This scenario is not supported.

These are the function calls get called during this scenario iHttpProperties->SetHttpHeaderL(const TDesC8& aHeaderName, const TDesC8& aValue); iHttpProperties->SetHttpMethodL(CSenHttpTransportProperties::ESenHttpGet); SendL(CSenSoapEnvelope& aMessage, const TDesC8& aProperties);

Inherits from

CSenHttpTransportProperties
- CSenTransportProperties
  - CSenXmlProperties
    - CBase

Public Member Functions
	~CSenHttpTransportProperties()
TInt	AcceptL(TPtrC8 &)
void	ApplyBindingL(TSOAPVersion)
HBufC8 *	AsUtf8L()
HBufC8 *	AsUtf8LC()
TInt	BoolPropertyL(const TDesC8 &, TBool &)
MSenProperties *	CloneL()
TInt	ContentTypeL(TPtrC8 &)
TInt	DeviceIDL(TPtrC8 &)
TInt	DownloadFolderL(TPtrC8 &)
TInt	FileAttachmentL(const TDesC8 &, HBufC8 *&)
TInt	HttpHeaderL(const TDesC8 &, TPtrC8 &)
TInt	HttpMethodL(TSenHttpMethod &)
TInt	HttpVersionL(TSenHttpVersion &)
TInt	IapIdL(TUint32 &)
TInt	IntPropertyL(const TDesC8 &, TInt &)
TBool	IsSafeToCast(TSenPropertiesClassType)
TInt	MwsNamespaceL(TPtrC8 &)
IMPORT_C CSenHttpTransportProperties *	NewL()
IMPORT_C CSenHttpTransportProperties *	NewL(const TDesC8 &, CSenXmlReader &)
IMPORT_C CSenHttpTransportProperties *	NewL(const CSenElement &)
IMPORT_C CSenHttpTransportProperties *	NewLC()
IMPORT_C CSenHttpTransportProperties *	NewLC(const TDesC8 &, CSenXmlReader &)
IMPORT_C CSenHttpTransportProperties *	NewLC(const CSenElement &)
TSenPropertiesClassType	PropertiesClassType()
TInt	PropertyL(const TDesC8 &, TPtrC8 &)
TInt	PropertyL(const TDesC8 &, TPtrC8 &, TPtrC8 &)
TInt	ProxyHostL(TPtrC8 &)
TInt	ProxyPortL(TInt &)
TInt	ProxyUsageL(TBool &)
void	ReadFromL(const TDesC8 &)
TInt	RemovePropertyL(const TDesC8 &)
TInt	SecureDialogL(TBool &)
void	SetAcceptL(const TDesC8 &)
TInt	SetBoolPropertyL(const TDesC8 &, const TBool)
void	SetContentTypeL(const TDesC8 &)
void	SetDeviceIDL(const TDesC8 &)
void	SetDownloadFolderL(const TDesC8 &)
TInt	SetFileAttachmentL(const TDesC8 &, const TDesC8 &)
void	SetHttpHeaderL(const TDesC8 &, const TDesC8 &)
void	SetHttpMethodL(TSenHttpMethod)
void	SetHttpVersionL(TSenHttpVersion)
void	SetIapIdL(TUint32)
TInt	SetIntPropertyL(const TDesC8 &, const TInt)
void	SetMwsNamespaceL(const TDesC8 &)
TInt	SetOmittedL(const TDesC8 &, TBool)
TInt	SetPropertyL(const TDesC8 &, const TDesC8 &)
TInt	SetPropertyL(const TDesC8 &, const TDesC8 &, const TDesC8 &)
void	SetProxyHostL(const TDesC8 &)
void	SetProxyPortL(TInt)
void	SetProxyUsageL(TBool)
void	SetReader(CSenXmlReader &)
void	SetSecureDialogL(TBool)
void	SetSnapIdL(TUint32)
void	SetSoapActionL(const TDesC8 &)
void	SetUserAgentL(const TDesC8 &)
TInt	SnapIdL(TUint32 &)
TInt	SoapActionL(TPtrC8 &)
TInt	UserAgentL(TPtrC8 &)
void	WriteToL(RWriteStream &)

Protected Member Functions
	CSenHttpTransportProperties()
void	BaseConstructL(const TDesC8 &, const TDesC8 &, CSenXmlReader *)
void	BaseConstructL(const TDesC8 &, const TDesC8 &, const TDesC8 &, CSenXmlReader *)
void	BaseConstructL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const TDesC8 &, CSenXmlReader *)
void	BaseConstructL(const CSenElement &)

Private Member Functions
HBufC8 *	AdaptDblQutesLC(const TDesC8 &)

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()
	CSenTransportProperties::CSenTransportProperties()
	CSenTransportProperties::Clone(TInt &)const
	CSenTransportProperties::EndpointResourceL(TPtrC8 &)
	CSenTransportProperties::HeartbeatL(TInt &)
	CSenTransportProperties::MaxTimeToLiveL(TInt &)
	CSenTransportProperties::MessageIdL(TPtrC8 &)
	CSenTransportProperties::MinTimeToLiveL(TInt &)
	CSenTransportProperties::OnewayMessageOnOffL(TBool &)
	CSenTransportProperties::SetEndpointResourceL(const TDesC8 &)
	CSenTransportProperties::SetHeartbeatL(TInt)
	CSenTransportProperties::SetMaxTimeToLiveL(TInt)
	CSenTransportProperties::SetMessageIdL(const TDesC8 &)
	CSenTransportProperties::SetMinTimeToLiveL(TInt)
	CSenTransportProperties::SetOnewayMessageOnOffL(TBool)
	CSenTransportProperties::~CSenTransportProperties()
	CSenXmlProperties::CSenXmlProperties()
	CSenXmlProperties::~CSenXmlProperties()

Public Member Enumerations
enum	TSenHttpMethod { ESenHttpPut, ESenHttpDelete, ESenHttpGet, ESenHttpPost }
enum	TSenHttpVersion { ESenHttp10, ESenHttp11 }

Inherited Attributes
	CSenXmlProperties::ipFragment
	CSenXmlProperties::ipReader

Constructor & Destructor Documentation

CSenHttpTransportProperties()

CSenHttpTransportProperties

(

)

[protected]

Constructor.

~CSenHttpTransportProperties()

~CSenHttpTransportProperties

(

)

[virtual]

Destructor.

Member Functions Documentation

AcceptL(TPtrC8 &)

TInt

AcceptL

(

TPtrC8 &

aAccept

)

[virtual]

Gets the Accept.

Parameters

TPtrC8 & aAccept

A TPtrC8 reference to be filled in with the value of the Accept.

AdaptDblQutesLC(const TDesC8 &)

HBufC8 *

AdaptDblQutesLC

(

const TDesC8 &

aValue

)

[private]

Parameters

const TDesC8 & aValue

ApplyBindingL(TSOAPVersion)

void

ApplyBindingL

(

TSOAPVersion

aSoapVersion

)

[virtual]

Apply binding.

Parameters

TSOAPVersion aSoapVersion

is a soap1.2 or soap1.1.

AsUtf8L()

HBufC8 *

AsUtf8L

(

)

[virtual]

AsUtf8LC()

HBufC8 *

AsUtf8LC

(

)

[virtual]

BaseConstructL(const TDesC8 &, const TDesC8 &, CSenXmlReader *)

void	BaseConstructL	(	const TDesC8 &	aLocalname,
			const TDesC8 &	aXml,
			CSenXmlReader *	aParser = NULL
		)	[protected, virtual]

Parameters

const TDesC8 & aLocalname
const TDesC8 & aXml
CSenXmlReader * aParser = NULL

BaseConstructL(const TDesC8 &, const TDesC8 &, const TDesC8 &, CSenXmlReader *)

void	BaseConstructL	(	const TDesC8 &	aNamespace,
			const TDesC8 &	aLocalname,
			const TDesC8 &	aXml,
			CSenXmlReader *	aParser = NULL
		)	[protected, virtual]

Parameters

const TDesC8 & aNamespace
const TDesC8 & aLocalname
const TDesC8 & aXml
CSenXmlReader * aParser = NULL

BaseConstructL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const TDesC8 &, CSenXmlReader *)

void	BaseConstructL	(	const TDesC8 &	aNamespace,
			const TDesC8 &	aLocalname,
			const TDesC8 &	aQualifiedName,
			const TDesC8 &	aXml,
			CSenXmlReader *	aParser = NULL
		)	[protected, virtual]

Parameters

const TDesC8 & aNamespace
const TDesC8 & aLocalname
const TDesC8 & aQualifiedName
const TDesC8 & aXml
CSenXmlReader * aParser = NULL

BaseConstructL(const CSenElement &)

void

BaseConstructL

(

const CSenElement &

aElement

)

[protected, virtual]

Parameters

const CSenElement & aElement

BoolPropertyL(const TDesC8 &, TBool &)

TInt	BoolPropertyL	(	const TDesC8 &	aName,
			TBool &	aValue
		)	[virtual]

Parameters

const TDesC8 & aName
TBool & aValue

CloneL()

MSenProperties *

CloneL

(

)

const [virtual]

ContentTypeL(TPtrC8 &)

TInt

ContentTypeL

(

TPtrC8 &

aContentType

)

[virtual]

Gets the information if IAPDialog is shown or not.

Parameters

TPtrC8 & aContentType

A TPtrC8 reference to be filled in with the value of the Content Type.

DeviceIDL(TPtrC8 &)

TInt

DeviceIDL

(

TPtrC8 &

aDeviceID

)

[virtual]

Gets the device ID

Parameters

TPtrC8 & aDeviceID

A TPtrC8 reference to be filled in with the value of the Device ID.

DownloadFolderL(TPtrC8 &)

TInt

DownloadFolderL

(

TPtrC8 &

aDownloadFolder

)

[virtual]

Gets download folder for incoming BLOB (binary large objects)

Parameters

TPtrC8 & aDownloadFolder

- A TPtrC8 reference to be filled in with the value of the shared, public folder for downloaded content

FileAttachmentL(const TDesC8 &, HBufC8 *&)

TInt	FileAttachmentL	(	const TDesC8 &	aCid,
			HBufC8 *&	aFileName
		)	[virtual]

Gets filename of file attachment

Parameters

const TDesC8 & aCid	- cid for filename
HBufC8 *& aFileName	- filename of file attachment with current cid

HttpHeaderL(const TDesC8 &, TPtrC8 &)

TInt	HttpHeaderL	(	const TDesC8 &	aHeaderName,
			TPtrC8 &	aValue
		)	[virtual]

Gets the Http header.

Parameters

const TDesC8 & aHeaderName	Name of the Http header.
TPtrC8 & aValue	A TPtrC8 reference to be filled in with the value of the Http header.

HttpMethodL(TSenHttpMethod &)

TInt

HttpMethodL

(

TSenHttpMethod &

aHttpMethod

)

[virtual]

Gets the Http method.

Parameters

TSenHttpMethod & aHttpMethod

A TSenHttpMethod reference to be filled in with the value of the Http method.

HttpVersionL(TSenHttpVersion &)

TInt

HttpVersionL

(

TSenHttpVersion &

aHttpVersion

)

[virtual]

Gets the Http version.

Parameters

TSenHttpVersion & aHttpVersion

A TSenHttpVersion reference to be filled in with the value of the Http version.

IapIdL(TUint32 &)

TInt

IapIdL

(

TUint32 &

aCurrentIapId

)

[virtual]

Gets the IAP ID.

Parameters

TUint32 & aCurrentIapId

A TUint32 reference to be filled in with the value of the IAP ID.

IntPropertyL(const TDesC8 &, TInt &)

TInt	IntPropertyL	(	const TDesC8 &	aName,
			TInt &	aValue
		)	[virtual]

Parameters

const TDesC8 & aName
TInt & aValue

IsSafeToCast(TSenPropertiesClassType)

TBool

IsSafeToCast

(

TSenPropertiesClassType

aClass

)

[virtual]

Parameters

TSenPropertiesClassType aClass

MwsNamespaceL(TPtrC8 &)

TInt

MwsNamespaceL

(

TPtrC8 &

aMwsNamespace

)

[virtual]

Gets namespace of Microsoft schema

Parameters

TPtrC8 & aMwsNamespace

- namespace

NewL()

IMPORT_C CSenHttpTransportProperties *

NewL

(

)

[static]

Basic constructor.

NewL(const TDesC8 &, CSenXmlReader &)

IMPORT_C CSenHttpTransportProperties *	NewL	(	const TDesC8 &	aXmlUtf8,
			CSenXmlReader &	aParser
		)	[static]

Basic constructor.

Parameters

const TDesC8 & aXmlUtf8
CSenXmlReader & aParser	It is a XML reader

NewL(const CSenElement &)

IMPORT_C CSenHttpTransportProperties *

NewL

(

const CSenElement &

aElement

)

[static]

Basic constructor.

Parameters

const CSenElement & aElement

NewLC()

IMPORT_C CSenHttpTransportProperties *

NewLC

(

)

[static]

Basic constructor.

NewLC(const TDesC8 &, CSenXmlReader &)

IMPORT_C CSenHttpTransportProperties *	NewLC	(	const TDesC8 &	aXmlUtf8,
			CSenXmlReader &	aParser
		)	[static]

Basic constructor.

Parameters

const TDesC8 & aXmlUtf8
CSenXmlReader & aParser	It is a XML reader

NewLC(const CSenElement &)

IMPORT_C CSenHttpTransportProperties *

NewLC

(

const CSenElement &

aElement

)

[static]

Basic constructor.

Parameters

const CSenElement & aElement

PropertiesClassType()

TSenPropertiesClassType

PropertiesClassType

(

)

[virtual]

PropertyL(const TDesC8 &, TPtrC8 &)

TInt	PropertyL	(	const TDesC8 &	aName,
			TPtrC8 &	aValue
		)	[virtual]

Parameters

const TDesC8 & aName
TPtrC8 & aValue

PropertyL(const TDesC8 &, TPtrC8 &, TPtrC8 &)

TInt	PropertyL	(	const TDesC8 &	aName,
			TPtrC8 &	aValue,
			TPtrC8 &	aType
		)	[virtual]

Gets the value of the property behind certain name.

Since: Series60

Parameters

const TDesC8 & aName	The name identifying this property.
TPtrC8 & aValue	A TPtrC8 reference to be filled in with the value of the property.
TPtrC8 & aType	A TPtrC8 reference to be filled in with the type of the property.

ProxyHostL(TPtrC8 &)

TInt

ProxyHostL

(

TPtrC8 &

aProxyHost

)

[virtual]

Gets the Proxy Host.

Parameters

TPtrC8 & aProxyHost

A TPtrC8 reference to be filled in with the value of the Proxy Host.

ProxyPortL(TInt &)

TInt

ProxyPortL

(

TInt &

aProxyPort

)

[virtual]

Gets the Proxy Port.

Parameters

TInt & aProxyPort

A TInt reference to be filled in with the value of the Proxy Port.

ProxyUsageL(TBool &)

TInt

ProxyUsageL

(

TBool &

aProxyUsage

)

[virtual]

Gets the Proxy Usage flag.

Parameters

TBool & aProxyUsage

A TBool reference to be filled in with the value of the Proxy Usage.

ReadFromL(const TDesC8 &)

void

ReadFromL

(

const TDesC8 &

aBuffer

)

[virtual]

Parameters

const TDesC8 & aBuffer

RemovePropertyL(const TDesC8 &)

TInt

RemovePropertyL

(

const TDesC8 &

aName

)

[virtual]

Parameters

const TDesC8 & aName

SecureDialogL(TBool &)

TInt

SecureDialogL

(

TBool &

aSecureDialog

)

[virtual]

Gets the information if SecureDialog is shown or not.

Parameters

TBool & aSecureDialog

SetAcceptL(const TDesC8 &)

void

SetAcceptL

(

const TDesC8 &

aAccept

)

[virtual]

Sets the Accept.

Parameters

const TDesC8 & aAccept

is the new Accept value.

SetBoolPropertyL(const TDesC8 &, const TBool)

TInt	SetBoolPropertyL	(	const TDesC8 &	aName,
			const TBool	aValue
		)	[virtual]

MSenProperties Leave codes: KErrSenInvalidCharacters if aName contains illegal characters. KErrSenZeroLengthDescriptor if aName is zero length.

Parameters

const TDesC8 & aName
const TBool aValue

SetContentTypeL(const TDesC8 &)

void

SetContentTypeL

(

const TDesC8 &

aContentType

)

[virtual]

Sets the Content Type.

Parameters

const TDesC8 & aContentType

is the new Content Type.

SetDeviceIDL(const TDesC8 &)

void

SetDeviceIDL

(

const TDesC8 &

aDeviceID

)

[virtual]

Sets the Device ID.

Parameters

const TDesC8 & aDeviceID

is the new Device ID.

SetDownloadFolderL(const TDesC8 &)

void

SetDownloadFolderL

(

const TDesC8 &

aDownloadFolder

)

[virtual]

Sets download folder for incoming BLOB (binary large objects)

Parameters

const TDesC8 & aDownloadFolder

- shared, public folder for downloaded content

SetFileAttachmentL(const TDesC8 &, const TDesC8 &)

TInt	SetFileAttachmentL	(	const TDesC8 &	aCid,
			const TDesC8 &	aFileName
		)	[virtual]

Sets filename of file attachment

Parameters

const TDesC8 & aCid	- cid for filename
const TDesC8 & aFileName	- filename of file attachment with current cid

SetHttpHeaderL(const TDesC8 &, const TDesC8 &)

void	SetHttpHeaderL	(	const TDesC8 &	aHeaderName,
			const TDesC8 &	aValue
		)	[virtual]

Sets the Http header.

Parameters

const TDesC8 & aHeaderName	Name of the Http header.
const TDesC8 & aValue	Value of the Http header

SetHttpMethodL(TSenHttpMethod)

void

SetHttpMethodL

(

TSenHttpMethod

aHttpMethod

)

[virtual]

Sets the Http method.

Parameters

TSenHttpMethod aHttpMethod

is the new Http method.

SetHttpVersionL(TSenHttpVersion)

void

SetHttpVersionL

(

TSenHttpVersion

aHttpVersion

)

[virtual]

Sets the Http version.

Parameters

TSenHttpVersion aHttpVersion

is the new Http version.

SetIapIdL(TUint32)

void

SetIapIdL

(

TUint32

aIapId

)

[virtual]

Sets the IAP ID.

Parameters

TUint32 aIapId

is the new IAP ID.

SetIntPropertyL(const TDesC8 &, const TInt)

TInt	SetIntPropertyL	(	const TDesC8 &	aName,
			const TInt	aValue
		)	[virtual]

MSenProperties Leave codes: KErrSenInvalidCharacters if aName contains illegal characters. KErrSenZeroLengthDescriptor if aName is zero length.

Parameters

const TDesC8 & aName
const TInt aValue

SetMwsNamespaceL(const TDesC8 &)

void

SetMwsNamespaceL

(

const TDesC8 &

aMwsNamespace

)

[virtual]

Sets namespace of Microsoft schema

Parameters

const TDesC8 & aMwsNamespace

- namespace

SetOmittedL(const TDesC8 &, TBool)

TInt	SetOmittedL	(	const TDesC8 &	aName,
			TBool	aValue
		)	[virtual]

Parameters

const TDesC8 & aName
TBool aValue

SetPropertyL(const TDesC8 &, const TDesC8 &)

TInt	SetPropertyL	(	const TDesC8 &	aName,
			const TDesC8 &	aValue
		)	[virtual]

MSenProperties Leave codes: KErrSenInvalidCharacters if aName contains illegal characters. KErrSenZeroLengthDescriptor if aName is zero length.

Parameters

const TDesC8 & aName
const TDesC8 & aValue

SetPropertyL(const TDesC8 &, const TDesC8 &, const TDesC8 &)

TInt	SetPropertyL	(	const TDesC8 &	aName,
			const TDesC8 &	aValue,
			const TDesC8 &	aType
		)	[virtual]

Sets new property.

If property with given name does not exist, new property with given value will be added. Otherwise the value of existing property will be updated.

Since: Series60

Parameters

const TDesC8 & aName	Name of the property, which can be later used to refer the given value.
const TDesC8 & aValue	Is the value of this property.
const TDesC8 & aType	Is the type of this property.

SetProxyHostL(const TDesC8 &)

void

SetProxyHostL

(

const TDesC8 &

aProxyHost

)

[virtual]

Sets the Proxy Host.

Parameters

const TDesC8 & aProxyHost

is the new Proxy Host.

SetProxyPortL(TInt)

void

SetProxyPortL

(

TInt

aProxyPort

)

[virtual]

Sets the Proxy Port.

Parameters

TInt aProxyPort

is the new Proxy Port.

SetProxyUsageL(TBool)

void

SetProxyUsageL

(

TBool

aProxyUsage

)

[virtual]

Sets the Proxy Usage flag.

Parameters

TBool aProxyUsage

is the new value for Proxy Usage.

SetReader(CSenXmlReader &)

void

SetReader

(

CSenXmlReader &

aReader

)

[virtual]

Parameters

CSenXmlReader & aReader

SetSecureDialogL(TBool)

void

SetSecureDialogL

(

TBool

aSecureDialog

)

[virtual]

Sets the flag which controls showing of SecureDialog.

Parameters

TBool aSecureDialog

is the new value for SecureDialog flag.

SetSnapIdL(TUint32)

void

SetSnapIdL

(

TUint32

aSnapId

)

[virtual]

Sets the SNAP ID.

Parameters

TUint32 aSnapId

is the new SNAP ID.

SetSoapActionL(const TDesC8 &)

void

SetSoapActionL

(

const TDesC8 &

aSoapAction

)

[virtual]

Sets the Soap Action.

Parameters

const TDesC8 & aSoapAction

is the new Soap Action.

SetUserAgentL(const TDesC8 &)

void

SetUserAgentL

(

const TDesC8 &

aUserAgent

)

[virtual]

Sets the UserAgent.

Parameters

const TDesC8 & aUserAgent

is the new User Agent.

SnapIdL(TUint32 &)

TInt

SnapIdL

(

TUint32 &

aCurrentSnapId

)

[virtual]

Gets the SNAP ID.

Parameters

TUint32 & aCurrentSnapId

A TUint32 reference to be filled in with the value of the SNAP ID.

SoapActionL(TPtrC8 &)

TInt

SoapActionL

(

TPtrC8 &

aSoapAction

)

[virtual]

Gets the SoapAction.

Parameters

TPtrC8 & aSoapAction

A TPtrC8 reference to be filled in with the value of the SoapAction.

UserAgentL(TPtrC8 &)

TInt

UserAgentL

(

TPtrC8 &

aUserAgent

)

[virtual]

Gets the UserAgent.

Parameters

TPtrC8 & aUserAgent

A TPtrC8 reference to be filled in with the value of the UserAgent.

WriteToL(RWriteStream &)

void

WriteToL

(

RWriteStream &

aWriteStream

)

[virtual]

Parameters

RWriteStream & aWriteStream

Member Enumerations Documentation

Enum TSenHttpMethod

HttpMethod Enumeration

Enumerators

ESenHttpPut
ESenHttpDelete
ESenHttpGet
ESenHttpPost

Enum TSenHttpVersion

HttpVersion Enumeration

Enumerators

ESenHttp10
ESenHttp11