CSenTransportProperties Class Reference

class CSenTransportProperties : public CSenXmlProperties

Inherits from

Public Member Functions
~CSenTransportProperties()
IMPORT_C voidApplyBindingL(TSOAPVersion)
IMPORT_C HBufC8 *AsUtf8L()
IMPORT_C HBufC8 *AsUtf8LC()
IMPORT_C TIntBoolPropertyL(const TDesC8 &, TBool &)
IMPORT_C MSenProperties *Clone(TInt &)
IMPORT_C MSenProperties *CloneL()
IMPORT_C TIntDeviceIDL(TPtrC8 &)
IMPORT_C TIntDownloadFolderL(TPtrC8 &)
IMPORT_C TIntEndpointResourceL(TPtrC8 &)
IMPORT_C TIntFileAttachmentL(const TDesC8 &, HBufC8 *&)
IMPORT_C TIntHeartbeatL(TInt &)
IMPORT_C TIntIapIdL(TUint32 &)
IMPORT_C TIntIntPropertyL(const TDesC8 &, TInt &)
IMPORT_C TBoolIsSafeToCast(TSenPropertiesClassType)
IMPORT_C TIntMaxTimeToLiveL(TInt &)
IMPORT_C TIntMessageIdL(TPtrC8 &)
IMPORT_C TIntMinTimeToLiveL(TInt &)
IMPORT_C TIntMwsNamespaceL(TPtrC8 &)
IMPORT_C CSenTransportProperties *NewL()
IMPORT_C CSenTransportProperties *NewL(const TDesC8 &, CSenXmlReader &)
IMPORT_C CSenTransportProperties *NewL(const CSenElement &)
IMPORT_C CSenTransportProperties *NewLC()
IMPORT_C CSenTransportProperties *NewLC(const TDesC8 &, CSenXmlReader &)
IMPORT_C CSenTransportProperties *NewLC(const CSenElement &)
IMPORT_C TIntOnewayMessageOnOffL(TBool &)
IMPORT_C TSenPropertiesClassTypePropertiesClassType()
IMPORT_C TIntPropertyL(const TDesC8 &, TPtrC8 &)
IMPORT_C TIntPropertyL(const TDesC8 &, TPtrC8 &, TPtrC8 &)
IMPORT_C TIntProxyHostL(TPtrC8 &)
IMPORT_C TIntProxyPortL(TInt &)
IMPORT_C TIntProxyUsageL(TBool &)
IMPORT_C voidReadFromL(const TDesC8 &)
IMPORT_C TIntRemovePropertyL(const TDesC8 &)
IMPORT_C TIntSecureDialogL(TBool &)
IMPORT_C TIntSetBoolPropertyL(const TDesC8 &, const TBool)
IMPORT_C voidSetDeviceIDL(const TDesC8 &)
IMPORT_C voidSetDownloadFolderL(const TDesC8 &)
IMPORT_C TIntSetEndpointResourceL(const TDesC8 &)
IMPORT_C TIntSetFileAttachmentL(const TDesC8 &, const TDesC8 &)
IMPORT_C TIntSetHeartbeatL(TInt)
IMPORT_C voidSetIapIdL(TUint32)
IMPORT_C TIntSetIntPropertyL(const TDesC8 &, const TInt)
IMPORT_C TIntSetMaxTimeToLiveL(TInt)
IMPORT_C voidSetMessageIdL(const TDesC8 &)
IMPORT_C TIntSetMinTimeToLiveL(TInt)
IMPORT_C voidSetMwsNamespaceL(const TDesC8 &)
IMPORT_C TIntSetOmittedL(const TDesC8 &, TBool)
IMPORT_C voidSetOnewayMessageOnOffL(TBool)
IMPORT_C TIntSetPropertyL(const TDesC8 &, const TDesC8 &)
IMPORT_C TIntSetPropertyL(const TDesC8 &, const TDesC8 &, const TDesC8 &)
IMPORT_C voidSetProxyHostL(const TDesC8 &)
IMPORT_C voidSetProxyPortL(TInt)
IMPORT_C voidSetProxyUsageL(TBool)
IMPORT_C voidSetReader(CSenXmlReader &)
IMPORT_C voidSetSecureDialogL(TBool)
IMPORT_C voidSetSnapIdL(TUint32)
IMPORT_C voidSetSoapActionL(const TDesC8 &)
IMPORT_C voidSetUserAgentL(const TDesC8 &)
IMPORT_C TIntSnapIdL(TUint32 &)
IMPORT_C TIntSoapActionL(TPtrC8 &)
IMPORT_C TIntUserAgentL(TPtrC8 &)
IMPORT_C voidWriteToL(RWriteStream &)
Protected Member Functions
CSenTransportProperties()
IMPORT_C voidBaseConstructL(const TDesC8 &, const TDesC8 &, CSenXmlReader *)
IMPORT_C voidBaseConstructL(const TDesC8 &, const TDesC8 &, const TDesC8 &, CSenXmlReader *)
IMPORT_C voidBaseConstructL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const TDesC8 &, CSenXmlReader *)
IMPORT_C voidBaseConstructL(const CSenElement &)
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()
CSenXmlProperties::CSenXmlProperties()
CSenXmlProperties::~CSenXmlProperties()
Private Attributes
TInt iFileAttachmentNum
Inherited Attributes
CSenXmlProperties::ipFragment
CSenXmlProperties::ipReader

Constructor & Destructor Documentation

CSenTransportProperties()

IMPORT_CCSenTransportProperties()[protected]

Constructor.

~CSenTransportProperties()

IMPORT_C~CSenTransportProperties()[virtual]

Destructor.

Member Functions Documentation

ApplyBindingL(TSOAPVersion)

IMPORT_C voidApplyBindingL(TSOAPVersionaSoapVersion)[virtual]

Apply binding.

Parameters

TSOAPVersion aSoapVersionis the version of Soap (1.1 or 1.2).

AsUtf8L()

IMPORT_C HBufC8 *AsUtf8L()[virtual]

AsUtf8LC()

IMPORT_C HBufC8 *AsUtf8LC()[virtual]

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

IMPORT_C voidBaseConstructL(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 *)

IMPORT_C voidBaseConstructL(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 *)

IMPORT_C voidBaseConstructL(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 &)

IMPORT_C voidBaseConstructL(const CSenElement &aElement)[protected, virtual]

Parameters

const CSenElement & aElement

BoolPropertyL(const TDesC8 &, TBool &)

IMPORT_C TIntBoolPropertyL(const TDesC8 &aName,
TBool &aValue
)[virtual]

Parameters

const TDesC8 & aName
TBool & aValue

Clone(TInt &)

IMPORT_C MSenProperties *Clone(TInt &aOkOrError)const [virtual]

Parameters

TInt & aOkOrError

CloneL()

IMPORT_C MSenProperties *CloneL()const [virtual]

DeviceIDL(TPtrC8 &)

IMPORT_C TIntDeviceIDL(TPtrC8 &aDeviceID)[virtual]

Gets the device ID

Parameters

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

DownloadFolderL(TPtrC8 &)

IMPORT_C TIntDownloadFolderL(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

EndpointResourceL(TPtrC8 &)

IMPORT_C TIntEndpointResourceL(TPtrC8 &aEndpointResource)[virtual]

Gets resource property value for endpoint

Parameters

TPtrC8 & aEndpointResource- is the suffix for endpoint

FileAttachmentL(const TDesC8 &, HBufC8 *&)

IMPORT_C TIntFileAttachmentL(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

HeartbeatL(TInt &)

IMPORT_C TIntHeartbeatL(TInt &aDelta)[virtual]

Gets the (connection) heartbeat property value as int.

Parameters

TInt & aDeltaA TInt reference to be filled in with the value of the heartbeat (in seconds). Positive value means that a heartbeat messages are sent to backend, keeping the socket connection open (longlived connection). Keeping heartbeat may be costy, but increases performance in scenarios, where multiple network transactions take place within short period (time window).

IapIdL(TUint32 &)

IMPORT_C TIntIapIdL(TUint32 &aCurrentIapId)[virtual]

Gets the IAP ID.

Parameters

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

IntPropertyL(const TDesC8 &, TInt &)

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

Parameters

const TDesC8 & aName
TInt & aValue

IsSafeToCast(TSenPropertiesClassType)

IMPORT_C TBoolIsSafeToCast(TSenPropertiesClassTypeaClass)[virtual]

Parameters

TSenPropertiesClassType aClass

MaxTimeToLiveL(TInt &)

IMPORT_C TIntMaxTimeToLiveL(TInt &aMaxTTL)[virtual]

Gets the (connection) max TTL property value as int.

SetHeartbeatL(TInt aDelta)

Parameters

TInt & aMaxTTLA TInt reference to be filled in with the value of the max TTL (in seconds).

MessageIdL(TPtrC8 &)

IMPORT_C TIntMessageIdL(TPtrC8 &aMessageId)[virtual]

Gets message ID

Parameters

TPtrC8 & aMessageId- is the id of the message

MinTimeToLiveL(TInt &)

IMPORT_C TIntMinTimeToLiveL(TInt &aMinTTL)[virtual]

Gets the (connection) min TTL property value as int.

SetHeartbeatL(TInt aDelta)

Parameters

TInt & aMinTTLA TInt reference to be filled in with the value of the min TTL (in seconds).

MwsNamespaceL(TPtrC8 &)

IMPORT_C TIntMwsNamespaceL(TPtrC8 &aMwsNamespace)[virtual]

Gets namespace of Microsoft schema

Parameters

TPtrC8 & aMwsNamespace- namespace

NewL()

IMPORT_C CSenTransportProperties *NewL()[static]

Basic constructor.

NewL(const TDesC8 &, CSenXmlReader &)

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

Basic constructor.

Parameters

const TDesC8 & aXmlUtf8
CSenXmlReader & aParserIt is a XML reader

NewL(const CSenElement &)

IMPORT_C CSenTransportProperties *NewL(const CSenElement &aElement)[static]

Basic constructor.

Parameters

const CSenElement & aElement

NewLC()

IMPORT_C CSenTransportProperties *NewLC()[static]

Basic constructor.

NewLC(const TDesC8 &, CSenXmlReader &)

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

Basic constructor.

Parameters

const TDesC8 & aXmlUtf8
CSenXmlReader & aParserIt is a XML reader

NewLC(const CSenElement &)

IMPORT_C CSenTransportProperties *NewLC(const CSenElement &aElement)[static]

Basic constructor.

Parameters

const CSenElement & aElement

OnewayMessageOnOffL(TBool &)

IMPORT_C TIntOnewayMessageOnOffL(TBool &aOnewayMessageOnOff)[virtual]

Gets one-way message mode.

Parameters

TBool & aOnewayMessageOnOff

PropertiesClassType()

IMPORT_C TSenPropertiesClassTypePropertiesClassType()[virtual]

PropertyL(const TDesC8 &, TPtrC8 &)

IMPORT_C TIntPropertyL(const TDesC8 &aName,
TPtrC8 &aValue
)[virtual]

Parameters

const TDesC8 & aName
TPtrC8 & aValue

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

IMPORT_C TIntPropertyL(const TDesC8 &aName,
TPtrC8 &aValue,
TPtrC8 &aType
)[virtual]
Gets the value of the property behind certain name.
Since
Series60

Parameters

const TDesC8 & aNameThe name identifying this property.
TPtrC8 & aValueA TPtrC8 reference to be filled in with the value of the property.
TPtrC8 & aTypeA TPtrC8 reference to be filled in with the type of the property.

ProxyHostL(TPtrC8 &)

IMPORT_C TIntProxyHostL(TPtrC8 &aProxyHost)[virtual]

Gets the Proxy Host.

Parameters

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

ProxyPortL(TInt &)

IMPORT_C TIntProxyPortL(TInt &aProxyPort)[virtual]

Gets the Proxy Port.

Parameters

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

ProxyUsageL(TBool &)

IMPORT_C TIntProxyUsageL(TBool &aProxyUsage)[virtual]

Gets the Proxy Usage flag.

Parameters

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

ReadFromL(const TDesC8 &)

IMPORT_C voidReadFromL(const TDesC8 &aBuffer)[virtual]

Parameters

const TDesC8 & aBuffer

RemovePropertyL(const TDesC8 &)

IMPORT_C TIntRemovePropertyL(const TDesC8 &aName)[virtual]

Parameters

const TDesC8 & aName

SecureDialogL(TBool &)

IMPORT_C TIntSecureDialogL(TBool &aSecureDialog)[virtual]

Gets the information if SecureDialog is shown or not.

Parameters

TBool & aSecureDialog

SetBoolPropertyL(const TDesC8 &, const TBool)

IMPORT_C TIntSetBoolPropertyL(const TDesC8 &aName,
const TBoolaValue
)[virtual]

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

Parameters

const TDesC8 & aName
const TBool aValue

SetDeviceIDL(const TDesC8 &)

IMPORT_C voidSetDeviceIDL(const TDesC8 &aDeviceID)[virtual]

Sets the Device ID.

Parameters

const TDesC8 & aDeviceIDis the new Device ID.

SetDownloadFolderL(const TDesC8 &)

IMPORT_C voidSetDownloadFolderL(const TDesC8 &aDownloadFolder)[virtual]

Sets download folder for incoming BLOB (binary large objects)

Parameters

const TDesC8 & aDownloadFoldershared, public folder for downloaded content

SetEndpointResourceL(const TDesC8 &)

IMPORT_C TIntSetEndpointResourceL(const TDesC8 &aEndpointResource)[virtual]

Sets resource property value for endpoint

Parameters

const TDesC8 & aEndpointResource- is the suffix for endpoint

SetFileAttachmentL(const TDesC8 &, const TDesC8 &)

IMPORT_C TIntSetFileAttachmentL(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

SetHeartbeatL(TInt)

IMPORT_C TIntSetHeartbeatL(TIntaDelta)[virtual]

Sets the (connection) heartbeat property value as int. Note, that with some transports, like vTCP, the heartbeat can also be used to control connection modes (longlive vs. shortlive connection). Hertbeat value is called also as delta.

Together with delta You can also set parameters Min & Max TTL Long and short connection is set in different way, below guider.

To setup longlive connection: delta : user defined min TTL : If not specified then the default value of 90 sec will be used max TTL : If not specified then the default value 1800 sec will be used

To setup shortlive connection: delta : -1 min TTL : If not specified then the default value of 90 sec will be used max TTL : ignored

So, providing a negative value (-1) can be utilized to disable heartbeat and to switch the connection mode to a short lived state. With vTCP transport, if heartbeat of -1 is set, the socket will be kept open only for effective timeout value (shortlived),

Parameters

TInt aDeltaTInt reference to be filled in with the value of the heartbeat (in seconds)

SetIapIdL(TUint32)

IMPORT_C voidSetIapIdL(TUint32aIapId)[virtual]

Sets the IAP ID.

Parameters

TUint32 aIapIdis the new IAP ID.

SetIntPropertyL(const TDesC8 &, const TInt)

IMPORT_C TIntSetIntPropertyL(const TDesC8 &aName,
const TIntaValue
)[virtual]

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

Parameters

const TDesC8 & aName
const TInt aValue

SetMaxTimeToLiveL(TInt)

IMPORT_C TIntSetMaxTimeToLiveL(TIntaMaxTTL)[virtual]

Sets the (connection) Max TTL for longlive connection.

SetHeartbeatL(TInt aDelta)

Parameters

TInt aMaxTTLTInt reference to be filled in with the value of the max TTL (in seconds)

SetMessageIdL(const TDesC8 &)

IMPORT_C voidSetMessageIdL(const TDesC8 &aMessageId)[virtual]

Sets message ID. Typically, this property is set per each message, instead of applying the same message ID for whole consumer session (service connection)

Parameters

const TDesC8 & aMessageId

SetMinTimeToLiveL(TInt)

IMPORT_C TIntSetMinTimeToLiveL(TIntaMinTTL)[virtual]

Sets the (connection) Min TTL

SetHeartbeatL(TInt aDelta)

Parameters

TInt aMinTTL

SetMwsNamespaceL(const TDesC8 &)

IMPORT_C voidSetMwsNamespaceL(const TDesC8 &aMwsNamespace)[virtual]

Sets namespace of Microsoft schema

Parameters

const TDesC8 & aMwsNamespace- namespace

SetOmittedL(const TDesC8 &, TBool)

IMPORT_C TIntSetOmittedL(const TDesC8 &aName,
TBoolaValue
)[virtual]

Parameters

const TDesC8 & aName
TBool aValue

SetOnewayMessageOnOffL(TBool)

IMPORT_C voidSetOnewayMessageOnOffL(TBoolaOnewayMessageOnOff)[virtual]

Sets the one-way message mode on/off. Typically, one-way messages are rarely used by default: instead, a request- response pair (consumer[request]<->[response]provider) transaction takes place. However, if one-way message mode is enabled, sending such message will typically result immediate callback from the transport (plug-in) itself. This means, that the actual service response from the provider is not being waited. Common use case to enable one-way message is when service connection is used in transmitting *responses* to notification request(s) that some remote consumer (from outside device) has sent earlier. Such notification requests may thus be received via hostlet connection (hc), and by enabling one-way message, once can reply via service connection, instead of calling hc->RespondL method. Furthermore, application might wish to enable one-way message mode to hostlet connection, if it is not interested of replying to these two-way notifications via hostlet connection, but wishes to use service connection instead.

Parameters

TBool aOnewayMessageOnOffis the new value of one-way message mode.

SetPropertyL(const TDesC8 &, const TDesC8 &)

IMPORT_C TIntSetPropertyL(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 &)

IMPORT_C TIntSetPropertyL(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 & aNameName of the property, which can be later used to refer the given value.
const TDesC8 & aValueIs the value of this property.
const TDesC8 & aTypeIs the type of this property.

SetProxyHostL(const TDesC8 &)

IMPORT_C voidSetProxyHostL(const TDesC8 &aProxyHost)[virtual]

Sets the Proxy Host.

Parameters

const TDesC8 & aProxyHostis the new Proxy Host.

SetProxyPortL(TInt)

IMPORT_C voidSetProxyPortL(TIntaProxyPort)[virtual]

Sets the Proxy Port.

Parameters

TInt aProxyPortis the new Proxy Port.

SetProxyUsageL(TBool)

IMPORT_C voidSetProxyUsageL(TBoolaProxyUsage)[virtual]

Sets the Proxy Usage flag.

Parameters

TBool aProxyUsageis the new value for Proxy Usage.

SetReader(CSenXmlReader &)

IMPORT_C voidSetReader(CSenXmlReader &aReader)[virtual]

Parameters

CSenXmlReader & aReader

SetSecureDialogL(TBool)

IMPORT_C voidSetSecureDialogL(TBoolaSecureDialog)[virtual]

Sets the flag which controls showing of SecureDialog.

Parameters

TBool aSecureDialogis the new value for SecureDialog flag.

SetSnapIdL(TUint32)

IMPORT_C voidSetSnapIdL(TUint32aSnapId)

Sets the SNAP ID.

Parameters

TUint32 aSnapIdis the new SNAP ID.

SetSoapActionL(const TDesC8 &)

IMPORT_C voidSetSoapActionL(const TDesC8 &aAction)[virtual]

Sets the Action.

Parameters

const TDesC8 & aActionis the new Soap Action.

SetUserAgentL(const TDesC8 &)

IMPORT_C voidSetUserAgentL(const TDesC8 &aUserAgent)[virtual]

Sets the UserAgent.

Parameters

const TDesC8 & aUserAgentis the new User Agent.

SnapIdL(TUint32 &)

IMPORT_C TIntSnapIdL(TUint32 &aCurrentSnapId)

Gets the SNAP ID.

Parameters

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

SoapActionL(TPtrC8 &)

IMPORT_C TIntSoapActionL(TPtrC8 &aAction)[virtual]

Gets the Action of message

Parameters

TPtrC8 & aActionA TPtrC8 reference to be filled in with the value of the Action.

UserAgentL(TPtrC8 &)

IMPORT_C TIntUserAgentL(TPtrC8 &aUserAgent)[virtual]

Gets the information if IAPDialog is shown or not.

Parameters

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

WriteToL(RWriteStream &)

IMPORT_C voidWriteToL(RWriteStream &aWriteStream)[virtual]

Parameters

RWriteStream & aWriteStream

Member Data Documentation

TInt iFileAttachmentNum

TInt iFileAttachmentNum[private]