examples/Base/IPC/AdvancedClientServerExample/driver/driver1.h

Go to the documentation of this file.

// Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
// All rights reserved.
// This component and the accompanying materials are made available
// under the terms of "Eclipse Public License v1.0"
// which accompanies this distribution, and is available
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
//
// Initial Contributors:
// Nokia Corporation - initial contribution.
//
// Contributors:
//
// Description:
// Interface to example Logical Device Driver
//



#ifndef __DRIVER1_H__
#define __DRIVER1_H__

#include <e32cmn.h>
#include <e32ver.h>
#ifndef __KERNEL_MODE__
#include <e32std.h>
#endif

class RDriver1 : public RBusLogicalChannel
        {
public:
        class TCaps
                {
        public:
                TVersion iVersion;
                };

        class TConfig
                {
        public:
                TInt iSpeed;                            
                TInt iPddBufferSize;            
                TInt iMaxSendDataSize;          
                TInt iMaxReceiveDataSize;       
                };
        typedef TPckgBuf<TConfig> TConfigBuf;

public:
        inline TInt Open();
        inline TInt GetConfig(TConfigBuf& aConfig);
        inline TInt SetConfig(const TConfigBuf& aConfig);
        inline void SendData(TRequestStatus &aStatus,const TDesC8& aData);
        inline void SendDataCancel();
        inline void ReceiveData(TRequestStatus &aStatus,TDes8& aBuffer);
        inline void ReceiveDataCancel();
        inline static const TDesC& Name();
        inline static TVersion VersionRequired();
private:
        enum TControl
                {
                EGetConfig,
                ESetConfig
                };

        enum TRequest
                {
                ESendData,
                EReceiveData,
                ENumRequests,
                EAllRequests = (1<<ENumRequests)-1
                };

        // Kernel side LDD channel is a friend
        friend class DDriver1Channel;
        };

inline const TDesC& RDriver1::Name()
        {
        _LIT(KDriver1Name,"DRIVER1");
        return KDriver1Name;
        }

inline TVersion RDriver1::VersionRequired()
        {
        const TInt KMajorVersionNumber=1;
        const TInt KMinorVersionNumber=0;
        const TInt KBuildVersionNumber=KE32BuildVersionNumber;
        return TVersion(KMajorVersionNumber,KMinorVersionNumber,KBuildVersionNumber);
        }

/*
  NOTE: The following methods would normally be exported from a seperate client DLL
  but are included in this header file for convenience.
*/

#ifndef __KERNEL_MODE__

inline TInt RDriver1::Open()
        {
        return DoCreate(Name(),VersionRequired(),KNullUnit,NULL,NULL,EOwnerThread);
        }

inline TInt RDriver1::GetConfig(TConfigBuf& aConfig)
        {
        return DoControl(EGetConfig,(TAny*)&aConfig);
        }

inline TInt RDriver1::SetConfig(const TConfigBuf& aConfig)
        {
        return DoControl(ESetConfig,(TAny*)&aConfig);
        }

inline void RDriver1::SendData(TRequestStatus &aStatus,const TDesC8& aData)
        {
        DoRequest(ESendData,aStatus,(TAny*)&aData);
        }

inline void RDriver1::SendDataCancel()
        {
        DoCancel(1<<ESendData);
        }

inline void RDriver1::ReceiveData(TRequestStatus &aStatus,TDes8& aBuffer)
        {
        DoRequest(EReceiveData,aStatus,(TAny*)&aBuffer);
        }

inline void RDriver1::ReceiveDataCancel()
        {
        DoCancel(1<<EReceiveData);
        }

#endif  // !__KERNEL_MODE__

#endif // __DRIVER1_H__

---