CObexWriterBase Class Reference
|
class CObexWriterBase : public CObexActiveRW
|
CObexWriterBase
provides obex specific writer behaviour for concrete writers to use. Derive from this class when providing a writer for a specific transport.
In a concrete writer the following things must be done: (a)In DoTransfer a write transfer is issued over the writer's transport (b)The NewL function must call
BaseConstructL()
. This is future proofing in the event that the iFuture1 variable is used and requires initialisation
Constructor & Destructor Documentation
CObexWriterBase(TPriority, MObexTransportNotify &, TObexConnectionInfo &)
~CObexWriterBase()
|
IMPORT_C
|
~CObexWriterBase
|
(
|
)
|
[virtual]
|
Member Functions Documentation
BaseConstructL()
|
IMPORT_C void
|
BaseConstructL
|
(
|
)
|
[protected]
|
This function is a placeholder for future use. If the iFuture1 variable is used it will need this function for any allocation required.
To prevent binary compatiblity breaks if the iFuture1 variable is used, this function must be called from the NewL of derived classes.
CompleteTransfer()
|
IMPORT_C
TBool
|
CompleteTransfer
|
(
|
)
|
[protected, virtual]
|
Returns true if the transfer has completed
DoTransfer()
|
void
|
DoTransfer
|
(
|
)
|
[protected, pure virtual]
|
This method issues a write of data over the relevant transport object.
NewRequest
GetInterface(TUid)
|
IMPORT_C
TAny
*
|
GetInterface
|
(
|
TUid
|
aUid
|
)
|
[protected, virtual]
|
This function is part of the extension pattern and is implemented by all derived instantiable classes that need to extend its interface.
By default this returns null. Any derived class that is required to extend its interface and that of this base class returns its new interface in the form of an M class, that it extends, if and only if the corresponding
TUid
, aUid, is received. Otherwise the function calls the base class implementation, returning NULL.
Parameters
|
TUid
aUid
|
The uid associated with the M Class that is being implemented
|
OnCompleteTransfer()
|
IMPORT_C void
|
OnCompleteTransfer
|
(
|
)
|
[protected, virtual]
|
Performs any actions necessary on completion of a write.
Remaining()
|
IMPORT_C
TInt
|
Remaining
|
(
|
)
|
[protected, virtual]
|
Return number of bytes remaining to be sent
StartTransfer(CObexPacket &)
|
IMPORT_C void
|
StartTransfer
|
(
|
CObexPacket
&
|
aPacket
|
)
|
[protected, virtual]
|
Start transfer. Calls into
CObexActiveRW
, which eventaully queues a write
Member Data Documentation
TAny * iFuture1
|
TAny
*
|
iFuture1
|
[protected]
|
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.