1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/btheader.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -0,0 +1,133 @@
1.4 +// Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// $Workfile: btHeader.h $
1.18 +// $Author: Stevep $
1.19 +// $Revision: 5 $
1.20 +// $Date: 23/01/02 13:31 $
1.21 +//
1.22 +//
1.23 +
1.24 +
1.25 +#if !defined (__BTHEADER_H__)
1.26 +#define __BTHEADER_H__
1.27 +
1.28 +
1.29 +#include <e32std.h>
1.30 +#include <obexheader.h> //CObexMtmHeader
1.31 +#include <obex.h> //TObexBluetoothProtocolInfo
1.32 +
1.33 +class CMsvStore;
1.34 +class RMsvReadStream;
1.35 +class RMsvWriteStream;
1.36 +
1.37 +
1.38 +// Stream version -- increment by one each time the externalized data format changes
1.39 +// for a significant release.
1.40 +const TInt32 KBtMessageStreamVersion = 1;///<Stream version
1.41 +const TUid KUidStreamBtHeaders = {0x1000AABC}; ///< Stream UID for the CBtHeaders object
1.42 +_LIT(KBtTransport, "RFCOMM");
1.43 +
1.44 +class CBtHeader : public CObexMtmHeader
1.45 +/**
1.46 +Base class for OBEX object headers. Allows them to be stored and restored to and from the
1.47 +CMsvStore.
1.48 +
1.49 +@internalTechnology
1.50 +@released
1.51 +*/
1.52 + {
1.53 +public:
1.54 +
1.55 + /**
1.56 + * Destructor. Empty
1.57 + */
1.58 +
1.59 + IMPORT_C ~CBtHeader();
1.60 +
1.61 + /**
1.62 + * Second-phase constructor. Calls BaseConstructL to initialise the base members
1.63 + */
1.64 +
1.65 + IMPORT_C void ConstructL();
1.66 +
1.67 + /**
1.68 + * Canonical NewL factory function
1.69 + */
1.70 +
1.71 + IMPORT_C static CBtHeader* NewL();
1.72 + //Setters/Getters
1.73 +
1.74 +
1.75 + /**
1.76 + * Get the BT protocol info of the recipient
1.77 + *
1.78 + * @return The protocol info of the recipient (NB: only one recipient is currently supported)
1.79 + */
1.80 +
1.81 + IMPORT_C virtual const TObexBluetoothProtocolInfo& BtProtocolInfo() const;
1.82 +
1.83 + /**
1.84 + * Get the BT address of the recipient
1.85 + *
1.86 + * @return The address of the recipient (NB: only one recipient is currently supported)
1.87 + */
1.88 +
1.89 + IMPORT_C virtual TPtrC8 Addr() const;
1.90 +
1.91 + /**
1.92 + * Set the BT address of the recipient. The RfComm service slot will be obtained through
1.93 + * an SDP lookup in the server side MTM.
1.94 + *
1.95 + * @param aAddr the address of the recipient (NB: only one recipient is currently supported)
1.96 + */
1.97 +
1.98 + IMPORT_C virtual void SetAddrL(const TDesC8& aAddr);
1.99 +
1.100 + //Called by Store/Restore--must be implelented in the base class, and must call
1.101 + //BaseExternalizeL/BaseInternaliseL first
1.102 +
1.103 + /**
1.104 + * Internaliser. Reads data in from aReadStream. Calls BaseInternalizeL() to read in the base
1.105 + * data first.
1.106 + *
1.107 + * @param aReadStream Stream to read data in from
1.108 + * @leave KErrXXX Standard EPOC stream leave codes
1.109 + */
1.110 +
1.111 + IMPORT_C virtual void InternalizeL(RMsvReadStream& aReadStream);
1.112 +
1.113 + /**
1.114 + * Externaliser. Writes data out to aWriteStream. Calls BaseExternalizeL() to write out
1.115 + * the base data first.
1.116 + *
1.117 + * @param aWriteStream Stream to write data to
1.118 + * @leave KErrXXX Standard SymbianOS stream leave codes
1.119 + */
1.120 +
1.121 + IMPORT_C virtual void ExternalizeL(RMsvWriteStream& aWriteStream) const;
1.122 +
1.123 +private:
1.124 +
1.125 + /**
1.126 + * Default constructor, initialises the base class and sets the value of iBtProtocolInfo.iTransport
1.127 + * as appropriate for BT
1.128 + */
1.129 +
1.130 + CBtHeader();
1.131 +
1.132 +private:
1.133 + TObexBluetoothProtocolInfo iBtProtocolInfo; ///< Protocol info to be internalised/externalised
1.134 + };
1.135 +
1.136 +#endif //!defined (__BTHEADER_H__)