MSenMessage Class Reference
This is abstract interface defines set of WSF message classes, providing convenience for other components, which typically cast this to some subclass via
IsSafeToCast() method. SenMessages.lib
- Since
- Series60 4.0
| Public Member Enumerations |
|---|
| enum | TClass {
EMessageBase = 0, EHttpGetMsg = 1, EHttpPostMsg = 2, EHttpPutMsg = 3, EHttpDeleteMsg = 4, ESoapEnvelope = 5, ESoapMessage = 6, ESoapEnvelope2 = 7, ESoapMessage2 = 8, ESoapMessageDom2 = 9, EAtomMessage = 10
} |
| enum | TDirection { EOutbound = 0, EInbound = 1 } |
Member Functions Documentation
CloneL()
Clone method that duplicates this message -- including all member data in the message. For the service consumers, a typical use case for cloning the message is when there is need to preserve the received response beyond the life time of a transaction. Normally, the response messages, that are owned by service connection are de-allocated after execution returns from MSenServiceConsumer interface's HandleMessageL or HandleErrorL method, back to the service connection.
Context()
Getter for message's context
Direction()
Gets the Message Direction
Properties()
Getter for message specific (transport) properties
SetContext(MSenMessageContext *)
Sets message context for this message. If context already exists, it is discarded and replaced by this context (context reset is performed).
Parameters
| MSenMessageContext * apNotOwnedContext | is the context. Ownership is NOT transferred to this message. |
SetProperties(MSenProperties *)
Sets properties for this message. Most typical use case is to set message spesific transport properties. 1. If message has context, the properties are (re)set into that context, discarding any pre-existing properties.
2. If context is NOT available, properties will be directly owned by this message.
Parameters
| MSenProperties * apOwnedProperties | pointer to the properties, which ownership is transferred to this class. This is performed in two different manners: |
TxnId()
|
TInt
| TxnId | ( | ) | [pure virtual] |
Getter for transaction ID of this message. In case of receiving a response message from service provider, this transaction ID may be used to map the response with request that the service consumer sent via service connection. In such case, the consumer can store return value from SendL method that was invoked in order maintain this mapping.
Member Enumerations Documentation
Enum TClass
Enumerators
| EMessageBase = 0 | |
| EHttpGetMsg = 1 | |
| EHttpPostMsg = 2 | |
| EHttpPutMsg = 3 | |
| EHttpDeleteMsg = 4 | |
| ESoapEnvelope = 5 | |
| ESoapMessage = 6 | |
| ESoapEnvelope2 = 7 | |
| ESoapMessage2 = 8 | |
| ESoapMessageDom2 = 9 | |
| EAtomMessage = 10 | |
Enum TDirection
Enumerators
| EOutbound = 0 | |
| EInbound = 1 | |
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.