CObexPacket Class Reference
class CObexPacket : public CBase
|
Packets, which are the basic unit transfered between CObex and the transport
Constructor & Destructor Documentation
CObexPacket(TUint16, TUint16)
~CObexPacket()
IMPORT_C
|
~CObexPacket
|
(
|
)
|
|
Member Functions Documentation
AddPacketProcessEvents(TObexPacketProcessEvents)
Adds events that should be notified.
Add events into the packet process events mask. When this packet is processed this mask will be checked and notifications will be issued only if the appropriate bits are set.
BufferSize()
IMPORT_C
TUint16
|
BufferSize
|
(
|
)
|
const
|
ConstructL()
void
|
ConstructL
|
(
|
)
|
[private]
|
DataLimit()
IMPORT_C
TUint16
|
DataLimit
|
(
|
)
|
const
|
Dump()
IMPORT_C void
|
Dump
|
(
|
)
|
const
|
Logs the size of the packet. If __LOG_PACKET_DUMP__ is defined (obex/common/logger.h) then also logs the packet's contents.
ExtractData(TObexData &)
Extract into the passed data object from iExtractPoint
Parameters
TObexData
& aHeader
|
Container for extracted data
|
Init(TObexOpcode)
Set up as a fresh packet with the given opcode.
InsertData(const TObexData &)
Insert the passed packet data object at iInsertPoint
Parameters
const
TObexData
& aHeader
|
OBEX header to insert
|
IsFinal()
IMPORT_C
TBool
|
IsFinal
|
(
|
)
|
const
|
True if the packet's final bit is set
Opcode()
Returns the packet opcode, with the final bit cleared (regardless of its actual value)
PacketProcessNotificationEvents()
Gets events that will be notified.
Retrieves the packet process events mask. When this packet is processed this mask will be checked and notifications will be issued only if the appropriate bits are set.
PacketSize()
IMPORT_C
TUint16
|
PacketSize
|
(
|
)
|
const
|
Returns the total size of the current packet.
Payload()
const
TUint8
*
|
Payload
|
(
|
)
|
const [private, inline]
|
Payload()
TUint8
*
|
Payload
|
(
|
)
|
[private, inline]
|
PayloadSize()
TUint16
|
PayloadSize
|
(
|
)
|
const [private, inline]
|
RemainingExtractSpace()
IMPORT_C
TUint16
|
RemainingExtractSpace
|
(
|
)
|
const
|
Returns the number of bytes of unread data in the obex packet (on reads)
RemainingInsertSpace()
IMPORT_C
TUint16
|
RemainingInsertSpace
|
(
|
)
|
const
|
Returns the number of bytes of unused space in the obex packet (on writes)
RemovePacketProcessEvents(TObexPacketProcessEvents)
Removes events from packet notification.
Remove events from the packet process events mask. When this packet is processed this mask will be checked and notifications will be issued only if the appropriate bits are set.
SetFinal(TBool)
IMPORT_C void
|
SetFinal
|
(
|
TBool
|
aFinal = ETrue
|
)
|
|
If aFinal == ETrue (default), the final bit is set, otherwise it is cleared.
Parameters
TBool
aFinal = ETrue
|
whether or not to set or clear the final bit
|
SetLegalDataLimit(TUint16)
Sets the data limit of the buffer, ensuring it's larger than minimum possible but not larger than the buffer Parameter passed in is the requested new data limit Returns size that was set
Parameters
TUint16
aSize
|
a Requested size for the data limit
|
SetOpcode(TObexOpcode)
Set the packet opcode to the passed value -- final bit will get through too.
SetPacketSize(TUint16)
IMPORT_C void
|
SetPacketSize
|
(
|
TUint16
|
aSize
|
)
|
|
Sets the crruent packet's size.
Member Data Documentation
TUint8 * iExtractPoint
TUint8
*
|
iExtractPoint
|
[private]
|
TUint8 * iInsertPoint
TUint8
*
|
iInsertPoint
|
[private]
|
TObexPacketProcessEvents
iNotificationEvents
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.