#include <mw/SenTransportProperties.h>
class CSenTransportProperties : public CSenXmlProperties |
Public Member Functions | |
---|---|
virtual | ~CSenTransportProperties() |
virtual IMPORT_C void | ApplyBindingL(TSOAPVersion) |
virtual IMPORT_C HBufC8 * | AsUtf8L() |
virtual IMPORT_C HBufC8 * | AsUtf8LC() |
virtual IMPORT_C TInt | BoolPropertyL(const TDesC8 &, TBool &) |
virtual IMPORT_C MSenProperties * | Clone(TInt &) |
virtual IMPORT_C MSenProperties * | CloneL() |
virtual IMPORT_C TInt | DeviceIDL(TPtrC8 &) |
virtual IMPORT_C TInt | DownloadFolderL(TPtrC8 &) |
virtual IMPORT_C TInt | EndpointResourceL(TPtrC8 &) |
virtual IMPORT_C TInt | FileAttachmentL(const TDesC8 &, HBufC8 *&) |
virtual IMPORT_C TInt | HeartbeatL(TInt &) |
virtual IMPORT_C TInt | IapIdL(TUint32 &) |
virtual IMPORT_C TInt | IntPropertyL(const TDesC8 &, TInt &) |
virtual IMPORT_C TBool | IsSafeToCast(TSenPropertiesClassType) |
virtual IMPORT_C TInt | MaxTimeToLiveL(TInt &) |
virtual IMPORT_C TInt | MessageIdL(TPtrC8 &) |
virtual IMPORT_C TInt | MinTimeToLiveL(TInt &) |
virtual IMPORT_C TInt | MwsNamespaceL(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 &) |
virtual IMPORT_C TInt | OnewayMessageOnOffL(TBool &) |
virtual IMPORT_C TSenPropertiesClassType | PropertiesClassType() |
virtual IMPORT_C TInt | PropertyL(const TDesC8 &, TPtrC8 &) |
virtual IMPORT_C TInt | PropertyL(const TDesC8 &, TPtrC8 &, TPtrC8 &) |
virtual IMPORT_C TInt | ProxyHostL(TPtrC8 &) |
virtual IMPORT_C TInt | ProxyPortL(TInt &) |
virtual IMPORT_C TInt | ProxyUsageL(TBool &) |
virtual IMPORT_C void | ReadFromL(const TDesC8 &) |
virtual IMPORT_C TInt | RemovePropertyL(const TDesC8 &) |
virtual IMPORT_C TInt | SecureDialogL(TBool &) |
virtual IMPORT_C TInt | SetBoolPropertyL(const TDesC8 &, const TBool) |
virtual IMPORT_C void | SetDeviceIDL(const TDesC8 &) |
virtual IMPORT_C void | SetDownloadFolderL(const TDesC8 &) |
virtual IMPORT_C TInt | SetEndpointResourceL(const TDesC8 &) |
virtual IMPORT_C TInt | SetFileAttachmentL(const TDesC8 &, const TDesC8 &) |
virtual IMPORT_C TInt | SetHeartbeatL(TInt) |
virtual IMPORT_C void | SetIapIdL(TUint32) |
virtual IMPORT_C TInt | SetIntPropertyL(const TDesC8 &, const TInt) |
virtual IMPORT_C TInt | SetMaxTimeToLiveL(TInt) |
virtual IMPORT_C void | SetMessageIdL(const TDesC8 &) |
virtual IMPORT_C TInt | SetMinTimeToLiveL(TInt) |
virtual IMPORT_C void | SetMwsNamespaceL(const TDesC8 &) |
virtual IMPORT_C TInt | SetOmittedL(const TDesC8 &, TBool) |
virtual IMPORT_C void | SetOnewayMessageOnOffL(TBool) |
virtual IMPORT_C TInt | SetPropertyL(const TDesC8 &, const TDesC8 &) |
virtual IMPORT_C TInt | SetPropertyL(const TDesC8 &, const TDesC8 &, const TDesC8 &) |
virtual IMPORT_C void | SetProxyHostL(const TDesC8 &) |
virtual IMPORT_C void | SetProxyPortL(TInt) |
virtual IMPORT_C void | SetProxyUsageL(TBool) |
virtual IMPORT_C void | SetReader(CSenXmlReader &) |
virtual IMPORT_C void | SetSecureDialogL(TBool) |
IMPORT_C void | SetSnapIdL(TUint32) |
virtual IMPORT_C void | SetSoapActionL(const TDesC8 &) |
virtual IMPORT_C void | SetUserAgentL(const TDesC8 &) |
IMPORT_C TInt | SnapIdL(TUint32 &) |
virtual IMPORT_C TInt | SoapActionL(TPtrC8 &) |
virtual IMPORT_C TInt | UserAgentL(TPtrC8 &) |
virtual IMPORT_C void | WriteToL(RWriteStream &) |
Protected Member Functions | |
---|---|
CSenTransportProperties() | |
virtual IMPORT_C void | BaseConstructL(const TDesC8 &, const TDesC8 &, CSenXmlReader *) |
virtual IMPORT_C void | BaseConstructL(const TDesC8 &, const TDesC8 &, const TDesC8 &, CSenXmlReader *) |
virtual IMPORT_C void | BaseConstructL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const TDesC8 &, CSenXmlReader *) |
virtual IMPORT_C void | BaseConstructL(const CSenElement &) |
Inherited Attributes | |
---|---|
CSenXmlProperties::ipFragment | |
CSenXmlProperties::ipReader |
IMPORT_C void | ApplyBindingL | ( | TSOAPVersion | aSoapVersion | ) | [virtual] |
Apply binding.
Parameter | Description |
---|---|
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] |
IMPORT_C void | BaseConstructL | ( | const TDesC8 & | aNamespace, |
const TDesC8 & | aLocalname, | |||
const TDesC8 & | aXml, | |||
CSenXmlReader * | aParser = NULL | |||
) | [protected, virtual] |
IMPORT_C void | BaseConstructL | ( | const TDesC8 & | aNamespace, |
const TDesC8 & | aLocalname, | |||
const TDesC8 & | aQualifiedName, | |||
const TDesC8 & | aXml, | |||
CSenXmlReader * | aParser = NULL | |||
) | [protected, virtual] |
IMPORT_C void | BaseConstructL | ( | const CSenElement & | aElement | ) | [protected, virtual] |
Reimplemented from CSenXmlProperties::BaseConstructL(const CSenElement &)
Reimplemented from CSenXmlProperties::BoolPropertyL(const TDesC8 &,TBool &)
IMPORT_C MSenProperties * | Clone | ( | TInt & | aOkOrError | ) | const [virtual] |
Reimplemented from CSenXmlProperties::Clone(TInt &)const
IMPORT_C MSenProperties * | CloneL | ( | ) | const [virtual] |
Reimplemented from CSenXmlProperties::CloneL()const
Gets download folder for incoming BLOB (binary large objects)
Parameter | Description |
---|---|
aDownloadFolder | - A TPtrC8 reference to be filled in with the value of the shared, public folder for downloaded content |
Returns: KErrNone if no error, or some of the system wide error codes.
Gets the (connection) heartbeat property value as int.
Parameter | Description |
---|---|
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). |
Returns: KErrNone if no error, or some of the system wide error codes. KErrNotFound if shortlive connection defined
Reimplemented from CSenXmlProperties::IntPropertyL(const TDesC8 &,TInt &)
IMPORT_C TBool | IsSafeToCast | ( | TSenPropertiesClassType | aClass | ) | [virtual] |
Reimplemented from CSenXmlProperties::IsSafeToCast(TSenPropertiesClassType)
Gets the (connection) max TTL property value as int.
See also: SetHeartbeatL(TInt aDelta)
Parameter | Description |
---|---|
aMaxTTL | A TInt reference to be filled in with the value of the max TTL (in seconds). |
Returns: KErrNotFound if shortlive connection defined KErrNone if no error, or some of the system wide error codes.
Gets the (connection) min TTL property value as int.
See also: SetHeartbeatL(TInt aDelta)
Parameter | Description |
---|---|
aMinTTL | A TInt reference to be filled in with the value of the min TTL (in seconds). |
Returns: KErrNone if no error, or some of the system wide error codes.
IMPORT_C CSenTransportProperties * | NewL | ( | ) | [static] |
Reimplemented from CSenXmlProperties::NewL()
Basic constructor.
Returns: a pointer to new CSenTransportProperties class instance.
IMPORT_C CSenTransportProperties * | NewL | ( | const TDesC8 & | aXmlUtf8, |
CSenXmlReader & | aParser | |||
) | [static] |
Reimplemented from CSenXmlProperties::NewL(const TDesC8 &,CSenXmlReader &)
Basic constructor.
Parameter | Description |
---|---|
aParser | It is a XML reader |
Returns: a pointer to new CSenTransportProperties class instance.
IMPORT_C CSenTransportProperties * | NewL | ( | const CSenElement & | aElement | ) | [static] |
Reimplemented from CSenXmlProperties::NewL(const CSenElement &)
Basic constructor.
Returns: a pointer to new CSenTransportProperties class instance.
IMPORT_C CSenTransportProperties * | NewLC | ( | ) | [static] |
Reimplemented from CSenXmlProperties::NewLC()
Basic constructor.
Returns: a pointer to new CSenTransportProperties class instance.
IMPORT_C CSenTransportProperties * | NewLC | ( | const TDesC8 & | aXmlUtf8, |
CSenXmlReader & | aParser | |||
) | [static] |
Reimplemented from CSenXmlProperties::NewLC(const TDesC8 &,CSenXmlReader &)
Basic constructor.
Parameter | Description |
---|---|
aParser | It is a XML reader |
Returns: a pointer to new CSenTransportProperties class instance.
IMPORT_C CSenTransportProperties * | NewLC | ( | const CSenElement & | aElement | ) | [static] |
Reimplemented from CSenXmlProperties::NewLC(const CSenElement &)
Basic constructor.
Returns: a pointer to new CSenTransportProperties class instance.
IMPORT_C TSenPropertiesClassType | PropertiesClassType | ( | ) | [virtual] |
Reimplemented from CSenXmlProperties::PropertiesClassType()
Reimplemented from CSenXmlProperties::PropertyL(const TDesC8 &,TPtrC8 &)
Reimplemented from CSenXmlProperties::PropertyL(const TDesC8 &,TPtrC8 &,TPtrC8 &)
Parameter | Description |
---|---|
aName | The name identifying this property. |
aValue | A TPtrC8 reference to be filled in with the value of the property. |
aType | A TPtrC8 reference to be filled in with the type of the property. |
Returns: KErrNone if no error, or some of the system wide error codes.
IMPORT_C void | ReadFromL | ( | const TDesC8 & | aBuffer | ) | [virtual] |
Reimplemented from CSenXmlProperties::ReadFromL(const TDesC8 &)
Reimplemented from CSenXmlProperties::RemovePropertyL(const TDesC8 &)
Reimplemented from CSenXmlProperties::SetBoolPropertyL(const TDesC8 &,const TBool)
See also: 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.
Parameter | Description |
---|---|
aDeviceID | is the new Device ID. |
IMPORT_C void | SetDownloadFolderL | ( | const TDesC8 & | aDownloadFolder | ) | [virtual] |
Sets download folder for incoming BLOB (binary large objects)
Parameter | Description |
---|---|
aDownloadFolder | shared, public folder for downloaded content |
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),
Parameter | Description |
---|---|
aDelta | TInt reference to be filled in with the value of the heartbeat (in seconds) |
Returns: KErrNone if no error, or some of the system wide error codes.
IMPORT_C void | SetIapIdL | ( | TUint32 | aIapId | ) | [virtual] |
Sets the IAP ID.
Parameter | Description |
---|---|
aIapId | is the new IAP ID. |
Reimplemented from CSenXmlProperties::SetIntPropertyL(const TDesC8 &,const TInt)
See also: MSenProperties Leave codes: KErrSenInvalidCharacters if aName contains illegal characters. KErrSenZeroLengthDescriptor if aName is zero length.
Sets the (connection) Max TTL for longlive connection.
See also: SetHeartbeatL(TInt aDelta)
Parameter | Description |
---|---|
aMaxTTL | TInt reference to be filled in with the value of the max TTL (in seconds) |
Returns: KErrNone if no error, or some of the system wide error codes.
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)
Returns: KErrNone if no error, or some of the system wide error codes.
Sets the (connection) Min TTL
See also: SetHeartbeatL(TInt aDelta)
Returns: KErrNone if no error, or some of the system wide error codes.
IMPORT_C void | SetMwsNamespaceL | ( | const TDesC8 & | aMwsNamespace | ) | [virtual] |
Sets namespace of Microsoft schema
Parameter | Description |
---|---|
aMwsNamespace | - namespace |
Returns: KErrNone if no error, or some of the system wide error codes.
Reimplemented from CSenXmlProperties::SetOmittedL(const TDesC8 &,TBool)
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.
Parameter | Description |
---|---|
aOnewayMessageOnOff | is the new value of one-way message mode. |
Reimplemented from CSenXmlProperties::SetPropertyL(const TDesC8 &,const TDesC8 &)
See also: MSenProperties Leave codes: KErrSenInvalidCharacters if aName contains illegal characters. KErrSenZeroLengthDescriptor if aName is zero length.
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.
Parameter | Description |
---|---|
aName | Name of the property, which can be later used to refer the given value. |
aValue | Is the value of this property. |
aType | Is the type of this property. |
Returns: KErrNone if no error, or some of the system wide error codes.
IMPORT_C void | SetProxyHostL | ( | const TDesC8 & | aProxyHost | ) | [virtual] |
Sets the Proxy Host.
Parameter | Description |
---|---|
aProxyHost | is the new Proxy Host. |
IMPORT_C void | SetProxyPortL | ( | TInt | aProxyPort | ) | [virtual] |
Sets the Proxy Port.
Parameter | Description |
---|---|
aProxyPort | is the new Proxy Port. |
IMPORT_C void | SetProxyUsageL | ( | TBool | aProxyUsage | ) | [virtual] |
Sets the Proxy Usage flag.
Parameter | Description |
---|---|
aProxyUsage | is the new value for Proxy Usage. |
IMPORT_C void | SetReader | ( | CSenXmlReader & | aReader | ) | [virtual] |
Reimplemented from CSenXmlProperties::SetReader(CSenXmlReader &)
IMPORT_C void | SetSecureDialogL | ( | TBool | aSecureDialog | ) | [virtual] |
Sets the flag which controls showing of SecureDialog.
Parameter | Description |
---|---|
aSecureDialog | is the new value for SecureDialog flag. |
IMPORT_C void | SetSnapIdL | ( | TUint32 | aSnapId | ) |
Sets the SNAP ID.
Parameter | Description |
---|---|
aSnapId | is the new SNAP ID. |
IMPORT_C void | SetSoapActionL | ( | const TDesC8 & | aAction | ) | [virtual] |
Sets the Action.
Parameter | Description |
---|---|
aAction | is the new Soap Action. |
IMPORT_C void | SetUserAgentL | ( | const TDesC8 & | aUserAgent | ) | [virtual] |
Sets the UserAgent.
Parameter | Description |
---|---|
aUserAgent | is the new User Agent. |
Gets the information if IAPDialog is shown or not.
Parameter | Description |
---|---|
aUserAgent | A TPtrC8 reference to be filled in with the value of the UserAgent. |
Returns: KErrNone if no error, or some of the system wide error codes. Sets the flag which controls showing of IAPDialog. KErrNone if no error, or some of the system wide error codes.
IMPORT_C void | WriteToL | ( | RWriteStream & | aWriteStream | ) | [virtual] |
Reimplemented from CSenXmlProperties::WriteToL(RWriteStream &)