class CSenTransportProperties : public CSenXmlProperties |
Protected Member Functions | |
---|---|
CSenTransportProperties () | |
IMPORT_C void | BaseConstructL (const TDesC8 &, const TDesC8 &, CSenXmlReader *) |
IMPORT_C void | BaseConstructL (const TDesC8 &, const TDesC8 &, const TDesC8 &, CSenXmlReader *) |
IMPORT_C void | BaseConstructL (const TDesC8 &, const TDesC8 &, const TDesC8 &, const TDesC8 &, CSenXmlReader *) |
IMPORT_C void | BaseConstructL (const CSenElement &) |
Private Attributes | |
---|---|
TInt | iFileAttachmentNum |
Inherited Attributes | |
---|---|
CSenXmlProperties::ipFragment | |
CSenXmlProperties::ipReader |
IMPORT_C void | ApplyBindingL | ( | TSOAPVersion | aSoapVersion | ) | [virtual] |
Apply binding.
TSOAPVersion aSoapVersion | is the version of Soap (1.1 or 1.2). |
IMPORT_C void | BaseConstructL | ( | const TDesC8 & | aLocalname, |
const TDesC8 & | aXml, | |||
CSenXmlReader * | aParser = NULL | |||
) | [protected, virtual] |
const TDesC8 & aLocalname | |
const TDesC8 & aXml | |
CSenXmlReader * aParser = NULL |
IMPORT_C void | BaseConstructL | ( | const TDesC8 & | aNamespace, |
const TDesC8 & | aLocalname, | |||
const TDesC8 & | aXml, | |||
CSenXmlReader * | aParser = NULL | |||
) | [protected, virtual] |
const TDesC8 & aNamespace | |
const TDesC8 & aLocalname | |
const TDesC8 & aXml | |
CSenXmlReader * aParser = NULL |
IMPORT_C void | BaseConstructL | ( | const TDesC8 & | aNamespace, |
const TDesC8 & | aLocalname, | |||
const TDesC8 & | aQualifiedName, | |||
const TDesC8 & | aXml, | |||
CSenXmlReader * | aParser = NULL | |||
) | [protected, virtual] |
const TDesC8 & aNamespace | |
const TDesC8 & aLocalname | |
const TDesC8 & aQualifiedName | |
const TDesC8 & aXml | |
CSenXmlReader * aParser = NULL |
IMPORT_C void | BaseConstructL | ( | const CSenElement & | aElement | ) | [protected, virtual] |
const CSenElement & aElement |
IMPORT_C TInt | BoolPropertyL | ( | const TDesC8 & | aName, |
TBool & | aValue | |||
) | [virtual] |
IMPORT_C MSenProperties * | Clone | ( | TInt & | aOkOrError | ) | const [virtual] |
TInt & aOkOrError |
IMPORT_C TInt | DeviceIDL | ( | TPtrC8 & | aDeviceID | ) | [virtual] |
Gets the device ID
TPtrC8 & aDeviceID | A TPtrC8 reference to be filled in with the value of the Device ID. |
IMPORT_C TInt | DownloadFolderL | ( | TPtrC8 & | aDownloadFolder | ) | [virtual] |
Gets download folder for incoming BLOB (binary large objects)
TPtrC8 & aDownloadFolder | - A TPtrC8 reference to be filled in with the value of the shared, public folder for downloaded content |
IMPORT_C TInt | EndpointResourceL | ( | TPtrC8 & | aEndpointResource | ) | [virtual] |
Gets resource property value for endpoint
TPtrC8 & aEndpointResource | - is the suffix for endpoint |
IMPORT_C TInt | FileAttachmentL | ( | const TDesC8 & | aCid, |
HBufC8 *& | aFileName | |||
) | [virtual] |
Gets filename of file attachment
IMPORT_C TInt | HeartbeatL | ( | TInt & | aDelta | ) | [virtual] |
Gets the (connection) heartbeat property value as int.
TInt & aDelta | A 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). |
IMPORT_C TInt | IapIdL | ( | TUint32 & | aCurrentIapId | ) | [virtual] |
Gets the IAP ID.
TUint32 & aCurrentIapId | A TUint32 reference to be filled in with the value of the IAP ID. |
IMPORT_C TInt | IntPropertyL | ( | const TDesC8 & | aName, |
TInt & | aValue | |||
) | [virtual] |
IMPORT_C TBool | IsSafeToCast | ( | TSenPropertiesClassType | aClass | ) | [virtual] |
TSenPropertiesClassType aClass |
IMPORT_C TInt | MaxTimeToLiveL | ( | TInt & | aMaxTTL | ) | [virtual] |
Gets the (connection) max TTL property value as int.
TInt & aMaxTTL | A TInt reference to be filled in with the value of the max TTL (in seconds). |
IMPORT_C TInt | MessageIdL | ( | TPtrC8 & | aMessageId | ) | [virtual] |
Gets message ID
TPtrC8 & aMessageId | - is the id of the message |
IMPORT_C TInt | MinTimeToLiveL | ( | TInt & | aMinTTL | ) | [virtual] |
Gets the (connection) min TTL property value as int.
TInt & aMinTTL | A TInt reference to be filled in with the value of the min TTL (in seconds). |
IMPORT_C TInt | MwsNamespaceL | ( | TPtrC8 & | aMwsNamespace | ) | [virtual] |
Gets namespace of Microsoft schema
TPtrC8 & aMwsNamespace | - namespace |
IMPORT_C CSenTransportProperties * | NewL | ( | const TDesC8 & | aXmlUtf8, |
CSenXmlReader & | aParser | |||
) | [static] |
Basic constructor.
const TDesC8 & aXmlUtf8 | |
CSenXmlReader & aParser | It is a XML reader |
IMPORT_C CSenTransportProperties * | NewL | ( | const CSenElement & | aElement | ) | [static] |
Basic constructor.
const CSenElement & aElement |
IMPORT_C CSenTransportProperties * | NewLC | ( | const TDesC8 & | aXmlUtf8, |
CSenXmlReader & | aParser | |||
) | [static] |
Basic constructor.
const TDesC8 & aXmlUtf8 | |
CSenXmlReader & aParser | It is a XML reader |
IMPORT_C CSenTransportProperties * | NewLC | ( | const CSenElement & | aElement | ) | [static] |
Basic constructor.
const CSenElement & aElement |
IMPORT_C TInt | OnewayMessageOnOffL | ( | TBool & | aOnewayMessageOnOff | ) | [virtual] |
Gets one-way message mode.
TBool & aOnewayMessageOnOff |
IMPORT_C TInt | PropertyL | ( | const TDesC8 & | aName, |
TPtrC8 & | aValue | |||
) | [virtual] |
IMPORT_C TInt | PropertyL | ( | const TDesC8 & | aName, |
TPtrC8 & | aValue, | |||
TPtrC8 & | aType | |||
) | [virtual] |
IMPORT_C TInt | ProxyHostL | ( | TPtrC8 & | aProxyHost | ) | [virtual] |
Gets the Proxy Host.
TPtrC8 & aProxyHost | A TPtrC8 reference to be filled in with the value of the Proxy Host. |
IMPORT_C TInt | ProxyPortL | ( | TInt & | aProxyPort | ) | [virtual] |
Gets the Proxy Port.
TInt & aProxyPort | A TInt reference to be filled in with the value of the Proxy Port. |
IMPORT_C TInt | ProxyUsageL | ( | TBool & | aProxyUsage | ) | [virtual] |
Gets the Proxy Usage flag.
TBool & aProxyUsage | A TBool reference to be filled in with the value of the Proxy Usage. |
IMPORT_C void | ReadFromL | ( | const TDesC8 & | aBuffer | ) | [virtual] |
const TDesC8 & aBuffer |
IMPORT_C TInt | RemovePropertyL | ( | const TDesC8 & | aName | ) | [virtual] |
const TDesC8 & aName |
IMPORT_C TInt | SecureDialogL | ( | TBool & | aSecureDialog | ) | [virtual] |
Gets the information if SecureDialog is shown or not.
TBool & aSecureDialog |
IMPORT_C TInt | SetBoolPropertyL | ( | const TDesC8 & | aName, |
const TBool | aValue | |||
) | [virtual] |
MSenProperties Leave codes: KErrSenInvalidCharacters if aName contains illegal characters. KErrSenZeroLengthDescriptor if aName is zero length.
IMPORT_C void | SetDeviceIDL | ( | const TDesC8 & | aDeviceID | ) | [virtual] |
Sets the Device ID.
const TDesC8 & aDeviceID | is the new Device ID. |
IMPORT_C void | SetDownloadFolderL | ( | const TDesC8 & | aDownloadFolder | ) | [virtual] |
Sets download folder for incoming BLOB (binary large objects)
const TDesC8 & aDownloadFolder | shared, public folder for downloaded content |
IMPORT_C TInt | SetEndpointResourceL | ( | const TDesC8 & | aEndpointResource | ) | [virtual] |
Sets resource property value for endpoint
const TDesC8 & aEndpointResource | - is the suffix for endpoint |
IMPORT_C TInt | SetFileAttachmentL | ( | const TDesC8 & | aCid, |
const TDesC8 & | aFileName | |||
) | [virtual] |
Sets filename of file attachment
IMPORT_C TInt | SetHeartbeatL | ( | TInt | aDelta | ) | [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),
TInt aDelta | TInt reference to be filled in with the value of the heartbeat (in seconds) |
IMPORT_C void | SetIapIdL | ( | TUint32 | aIapId | ) | [virtual] |
Sets the IAP ID.
TUint32 aIapId | is the new IAP ID. |
IMPORT_C TInt | SetIntPropertyL | ( | const TDesC8 & | aName, |
const TInt | aValue | |||
) | [virtual] |
MSenProperties Leave codes: KErrSenInvalidCharacters if aName contains illegal characters. KErrSenZeroLengthDescriptor if aName is zero length.
IMPORT_C TInt | SetMaxTimeToLiveL | ( | TInt | aMaxTTL | ) | [virtual] |
Sets the (connection) Max TTL for longlive connection.
TInt aMaxTTL | TInt reference to be filled in with the value of the max TTL (in seconds) |
IMPORT_C void | SetMessageIdL | ( | 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)
const TDesC8 & aMessageId |
IMPORT_C TInt | SetMinTimeToLiveL | ( | TInt | aMinTTL | ) | [virtual] |
Sets the (connection) Min TTL
TInt aMinTTL |
IMPORT_C void | SetMwsNamespaceL | ( | const TDesC8 & | aMwsNamespace | ) | [virtual] |
Sets namespace of Microsoft schema
const TDesC8 & aMwsNamespace | - namespace |
IMPORT_C TInt | SetOmittedL | ( | const TDesC8 & | aName, |
TBool | aValue | |||
) | [virtual] |
IMPORT_C void | SetOnewayMessageOnOffL | ( | TBool | aOnewayMessageOnOff | ) | [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.
TBool aOnewayMessageOnOff | is the new value of one-way message mode. |
IMPORT_C TInt | SetPropertyL | ( | const TDesC8 & | aName, |
const TDesC8 & | aValue | |||
) | [virtual] |
MSenProperties Leave codes: KErrSenInvalidCharacters if aName contains illegal characters. KErrSenZeroLengthDescriptor if aName is zero length.
IMPORT_C 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.
IMPORT_C void | SetProxyHostL | ( | const TDesC8 & | aProxyHost | ) | [virtual] |
Sets the Proxy Host.
const TDesC8 & aProxyHost | is the new Proxy Host. |
IMPORT_C void | SetProxyPortL | ( | TInt | aProxyPort | ) | [virtual] |
Sets the Proxy Port.
TInt aProxyPort | is the new Proxy Port. |
IMPORT_C void | SetProxyUsageL | ( | TBool | aProxyUsage | ) | [virtual] |
Sets the Proxy Usage flag.
TBool aProxyUsage | is the new value for Proxy Usage. |
IMPORT_C void | SetReader | ( | CSenXmlReader & | aReader | ) | [virtual] |
CSenXmlReader & aReader |
IMPORT_C void | SetSecureDialogL | ( | TBool | aSecureDialog | ) | [virtual] |
Sets the flag which controls showing of SecureDialog.
TBool aSecureDialog | is the new value for SecureDialog flag. |
IMPORT_C void | SetSnapIdL | ( | TUint32 | aSnapId | ) |
Sets the SNAP ID.
TUint32 aSnapId | is the new SNAP ID. |
IMPORT_C void | SetSoapActionL | ( | const TDesC8 & | aAction | ) | [virtual] |
Sets the Action.
const TDesC8 & aAction | is the new Soap Action. |
IMPORT_C void | SetUserAgentL | ( | const TDesC8 & | aUserAgent | ) | [virtual] |
Sets the UserAgent.
const TDesC8 & aUserAgent | is the new User Agent. |
IMPORT_C TInt | SnapIdL | ( | TUint32 & | aCurrentSnapId | ) |
Gets the SNAP ID.
TUint32 & aCurrentSnapId | A TUint32 reference to be filled in with the value of the SNAP ID. |
IMPORT_C TInt | SoapActionL | ( | TPtrC8 & | aAction | ) | [virtual] |
Gets the Action of message
TPtrC8 & aAction | A TPtrC8 reference to be filled in with the value of the Action. |
IMPORT_C TInt | UserAgentL | ( | TPtrC8 & | aUserAgent | ) | [virtual] |
Gets the information if IAPDialog is shown or not.
TPtrC8 & aUserAgent | A TPtrC8 reference to be filled in with the value of the UserAgent. |
IMPORT_C void | WriteToL | ( | RWriteStream & | aWriteStream | ) | [virtual] |
RWriteStream & aWriteStream |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.