class CObexBaseObject : public CBase |
Objects of this class are used to describe the objects to be transferred and those received via Obex. Consists of a number of attributes describing the object, along with methods to set them. CObexBaseObject is an abstract base class, which defines attribute setting and transferring functionality, but does not specify the storage mechanism for the data part (called the object body) of the object. This body part is defined in derived classes.
Object description attributes are tracked for validity automatically, so that only valid attributes are sent to the remote machine. Also has the concept of "header masks". This selects which of the various attributes will actually be sent out/read in when the object is used in an operation with the remote machine. Objects default to transferring all valid attributes, use the header mask if restriction is required on the headers exchanged.
See the various derived classes for description of object body representation.
The common attributes are defined to be as close to the underlying OBEX headers as usefully possible, hence any OBEX header specified as a Unicode string (e.g. Name) translate to TDes (variant) EPOC descriptors, "byte sequences" (e.g. Type) are TDes8 (or ASCII invariant), and byte and 32 bit integers (e.g. Length) are TUint32s.
This class is not designed for user derivation (ie. outside of this dll).
Protected Member Functions | |
---|---|
CObexBaseObject() | |
void | CreateHeaderStorageDataL() |
TInt | DataSize() |
void | GetData(TInt, TDes8 &) |
void | GuessTypeFromExtL(const TDesC &) |
void | NewData(TInt, TDes8 &) |
void | ResetData() |
void | ResetHeaders() |
void | SetTimeHeaderL(const TDesC8 &) |
void | SetUtcTimeL(const TTime) |
Public Member Enumerations | |
---|---|
enum | TProgress { EContinue, EComplete, EError, ELastPacket } |
IMPORT_C void | AddHeaderL | ( | CObexHeader & | aHeader | ) |
Adds a CObexHeader into the CObexHeaderSet
CObexHeader & aHeader | A Pointer to a CObexHeader to be added to the CObexHeaderSet |
IMPORT_C void | AddHttpL | ( | const TDesC8 & | aDesc | ) |
Add an Http header.
const TDesC8 & aDesc | HTTP header to be added to the object's collection of HTTP headers |
IMPORT_C const TDesC8 & | AppParam | ( | ) | const |
Gets the object's Application Parameters attribute
This function does not parse the Application Parameters attribute into the expected Tag-Length-Value format.
IMPORT_C TInt | BytesReceived | ( | ) |
Returns the number of bytes of the body of the object transferred while receiving an object.
IMPORT_C TInt | BytesSent | ( | ) |
Returns the number of bytes of the body of the object transferred so far while sending this object.
TObexResponse | GetLastError | ( | ) | const |
Returns the Obex Error response code from the last call to CObexBaseObject::ParseNextReceivePacket
void | GuessTypeFromExtL | ( | const TDesC & | aExt | ) | [protected] |
Makes a first level guess at setting the mime type from the file extension.
This API is deprecated and may be removed at any time. For any production applications, the versit and the Application architecture (see RApaLsSession::RecognizeData) provide far more flexibilty and robustness.
6.1
const TDesC & aExt |
IMPORT_C TObexHeaderMask | HeaderMask | ( | ) |
Returns the currently set header mask. This defaults to 0xFF (i.e. allow everything) when Reset () or InitFromFileL is called. This does not specify which headers currently contain valid data--merely which headers will be transferred if they do contain valid data.
IMPORT_C const RPointerArray< HBufC8 > * | Http | ( | ) | const |
Firstly updates the iHttp list, ensuring that the entries are the same as those HTTP headers within the header set. (The iHttp list could have contained old headers that were removed from the headerset using the DeleteMasked operation) Returns a pointer to the Http header array or null if no headers defined.
TInt | InitSend | ( | TObexOpcode | aOpcode | ) |
Prepare the object for sending. Each packet sent will contain aOpcode.
TObexOpcode aOpcode |
IMPORT_C TUint32 | Length | ( | ) |
Gets the object's Length attribute.
Note this might not match the size of the file (if any) to transfer.
TProgress | ParseNextReceivePacket | ( | CObexPacket & | aPacket | ) |
Parse the passed packet, consuming headers into this object as appropriate. The returned progress can not be relied upon to indicate completion, because that is actually signalled at a diferent level, depending on the source of the packet(final bit or server complete response). Returning EComplete simply indicates that all of the object body has been received.
CObexPacket & aPacket | The packet to extract the headers from |
void | PrepareConnectionHeader | ( | CObexPacket & | aPacket | ) |
Fill up the Connect command with the appropriate headers.
CObexPacket & aPacket | The packet to be filled |
TProgress | PrepareNextSendPacket | ( | CObexPacket & | aPacket | ) |
Fill up aPacket with whatever is left to be sent of the object. Trys to get attribute headers out asap, and tacks as much of the data part of the object onto the end of each packet as will fit. Returned value goes to EComplete on the call *after* the final packet has been written(i.e. indicates nothing left to do).
CObexPacket & aPacket | The packet to be filled |
IMPORT_C void | Reset | ( | ) |
Resets the object, to make it represent nothing.
Call this before setting a CObexObject to represent a new object.
void | ResetHeaders | ( | ) | [protected] |
Sets header mask to 1's (include all), but valid mask to 0's (none valid). Also reset progress indicators to avoid any un-initialised transfer attempts
IMPORT_C void | SetAppParamL | ( | const TDesC8 & | aDesc | ) |
Sets the Application Parameters attribute of the object.
This is expected to be of the format Tag-Length-Value, but this is not enforced.
const TDesC8 & aDesc | Application Parameters attribute |
void | SetConnectionIdL | ( | TUint32 | aFourByte | ) |
Set the connection id. This method will check the headerset for a connectionId header. If one if located, then this will be modified for the new HV value. If not, a new connectionId header will be added.
TUint32 aFourByte | The connectionID to be set |
IMPORT_C void | SetDescriptionL | ( | const TDesC & | aDesc | ) |
Sets the Description attribute of the object.
This is currently the easiest way to send proprietary information along with an object.
const TDesC & aDesc | Description attribute |
IMPORT_C void | SetHeaderMask | ( | const TObexHeaderMask | aHeaderMask | ) |
Sets the header mask. aHeaderMask is built up by bit-wise or ing any of the KObexHdr... constants. For example, if it is set to KObexHdrName | KObexHdrLength, only these two headers will be specified in transfer operations with the remote machine, even if there are other valid attributes which could be used. In effect, this mask is bit-wise and ed with the "valid headers" mask when determining which headers are valid for the purposes of transfers.
const TObexHeaderMask aHeaderMask |
IMPORT_C void | SetLengthL | ( | const TUint32 | aLength | ) |
Sets the Length attribute of the object, in bytes.
Note that this does not necessarily have to match the exact size of the body data, but is used to give an indication of the size to the receiving end.
const TUint32 aLength | Length attribute of the object |
IMPORT_C void | SetNameL | ( | const TDesC & | aDesc | ) |
Sets the Name attribute of the object.
The Name is used to identify the object to the remote machine (or to identify a received object). Note that in general, this is quite distinct from the CObexFileObject::DataFile() attribute, which specifies where the body of the object is stored.
const TDesC & aDesc | Name attribute |
IMPORT_C void | SetTargetL | ( | const TDesC8 & | aDesc | ) |
Sets the Target attribute of the object.
Generally, this will only have any useful meaning if the session Who attribute of the remote machine is recognised, and particularly, when connected to a strict peer (see CObex::IsStrictPeer()).
const TDesC8 & aDesc | Target attribute |
void | SetTimeHeaderL | ( | const TDesC8 & | aTimeDes | ) | [protected] |
Add a descriptor as the one and only Time header in an object.
const TDesC8 & aTimeDes | A narrow descriptor which will be stored in the object. |
IMPORT_C void | SetTimeL | ( | const TTime | aLocalTime | ) |
Sets the Time attribute of the object (stored in UTC).
const TTime aLocalTime | Time attribute in local time |
IMPORT_C void | SetTypeL | ( | const TDesC8 & | aDesc | ) |
Sets the Type attribute of the object.
This should be in the form of a valid IANA media type (see http://www.iana.org/assignments/media-types/index.html).
const TDesC8 & aDesc | Type attribute |
void | SetUtcTimeL | ( | const TTime | aUtcTime | ) | [protected] |
Sets the Time attribute of the object (stored in UTC).
const TTime aUtcTime | Time attribute in local time |
IMPORT_C const TTime | Time | ( | ) |
Returns the time attribute of the object in local time. Returns TTime (0) if no valid time has been set.
IMPORT_C TObexHeaderMask | ValidHeaders | ( | ) |
Returns the current valid header mask. This allows inspection of the current set of valid headers, particularly useful for determining whether a put object contained a body header (important for deleting files as part of file transfer).
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.