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

Go to the documentation of this file.

/*
Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of Nokia Corporation nor the names of its contributors
  may be used to endorse or promote products derived from this software
  without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

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__

---