examples/Base/IPC/ClientServer/Simple/SimpleServer.cpp

/*
Copyright (c) 2000-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:
The implementation of our simple server that increments and decrements a simple counter value.
**NOTE**: The example does not demonstrate any security features - its purpose is simply
to demonstrate the basic principles of client/server interaction.  
*/



#include "ClientServer.h"
#include "SimpleServer.h"
#include <e32svr.h>
#include <e32uid.h>


//**********************************
//CCountServServer - implementations
//**********************************

CCountServServer::CCountServServer(CActive::TPriority aActiveObjectPriority)
        : CServer2(aActiveObjectPriority)
        {
        }


CSession2* CCountServServer::NewSessionL(const TVersion& aVersion,const RMessage2& /*aMessage*/) const
    {
      // Check that the version is OK
    TVersion v(KCountServMajorVersionNumber,KCountServMinorVersionNumber,KCountServBuildVersionNumber);
        if (!User::QueryVersionSupported(v,aVersion))
                User::Leave(KErrNotSupported);  
        
        // CAN USE THE aMessage argument to check client's security and identity
        // can make use of this later but for now ignore. AH 4/5/05
        // the connect message is delivered via the RMessage2 object passed. 
        
        // do something with this later (and move it to the start of the function?)
        
          // Create the session.
        return new (ELeave) CCountServSession;
        }


void CCountServServer::PanicServer(TCountServPanic aPanic)
        {
        _LIT(KTxtServerPanic,"Count server panic");
        User::Panic(KTxtServerPanic,aPanic);
        }


//***********************************
//CCountServSession - implementations
//***********************************


CCountServSession::CCountServSession()
        {
    }

void CCountServSession::ServiceL(const RMessage2& aMessage)
        {
        TRAPD(err,DispatchMessageL(aMessage));
        aMessage.Complete(err);
        }

void CCountServSession::DispatchMessageL(const RMessage2& aMessage)
        {
        switch (aMessage.Function())
        {
        case ECountServSetFromString:
                SetFromStringL(aMessage);
                return;
        case ECountServIncrease:
                Increase();
                return;
        case ECountServIncreaseBy:
                IncreaseBy(aMessage);
                return;
        case ECountServDecrease:
                Decrease();
                return;
        case ECountServDecreaseBy:
                DecreaseBy(aMessage);
                return;
        case ECountServReset:
                Reset();
                return;
        case ECountServValue:
                CounterValueL(aMessage);
                return;
          
          // This is an example of a request that we know about, but don't support.
          // We cause KErrNotSupported to be returned to the client.
        case ECountServUnsupportedRequest:
                User::Leave(KErrNotSupported);
                
         //  Requests that we don't understand at all are a different matter.
         //  This is considered a client programming error, so we panic the 
         //  client - this also completes the message.
        default:
                PanicClient(aMessage,EBadRequest);
                return;
        }
        }

void CCountServSession::SetFromStringL(const RMessage2& aMessage)
        {
        
          // length of passed descriptor (1st parameter passed from client)
        TInt deslen = aMessage.GetDesLength(0);
        
          // Passed data will be saved in this descriptor.
    RBuf buffer;
      
      // Max length set to the value of "deslen", but current length is zero
    buffer.CreateL(deslen);
      
      // Do the right cleanup if anything subsequently goes wrong
    buffer.CleanupClosePushL();
    
      // Copy the client's descriptor data into our buffer.
    aMessage.ReadL(0,buffer,0);
    
      // Now do a validation to make sure that the string only has digits
    if (buffer.Length() == 0)
        {
        User::Leave(ENonNumericString);
        }
    
    TLex16 lexer;
    
    lexer.Assign(buffer);
    while (!lexer.Eos())
        {
        TChar thechar;
        
        thechar = lexer.Peek();
        if (!thechar.IsDigit())
            {
                User::Leave(ENonNumericString);
            }
        lexer.Inc();
        }
       
      // Convert to a simple TInt value. 
    lexer.Assign(buffer);           
    if (lexer.Val(iCount))
        {
        User::Leave(ENonNumericString);
        }
        
          // Clean up the memory acquired by the RBuf variable "buffer"
        CleanupStack::PopAndDestroy();
        }


void CCountServSession::Increase()
        {
        iCount++;
        }


void CCountServSession::IncreaseBy(const RMessage2& aMessage)
        {
        iCount = iCount + aMessage.Int0();
        }

void CCountServSession::Decrease()
        {
        iCount--;
        }


void CCountServSession::DecreaseBy(const RMessage2& aMessage)
        {
        iCount = iCount - aMessage.Int0();      
        }


void CCountServSession::Reset()
        {
        iCount=0;
        }


void CCountServSession::CounterValueL(const RMessage2& aMessage)
        {
        TPckgBuf<TInt> p(iCount);
        aMessage.WriteL(0,p);
        }


void CCountServSession::PanicClient(const RMessage2& aMessage,TInt aPanic) const
        {
        _LIT(KTxtServer,"CountServ server");
        aMessage.Panic(KTxtServer,aPanic);
        }



//**********************************
//Global functions
//**********************************

// The count server thread function that initialises the server.
GLDEF_C TInt CCountServServer::ThreadFunction(TAny* )
        {
          // get clean-up stack
        CTrapCleanup* cleanup=CTrapCleanup::New();
        if (cleanup == NULL)
            {
                CCountServServer::PanicServer(ECreateTrapCleanup);
            }
        
          // create an active scheduler and server
        CActiveScheduler *pA=new CActiveScheduler;
        __ASSERT_ALWAYS(pA!=NULL,CCountServServer::PanicServer(EMainSchedulerError));
        CCountServServer *pS=new CCountServServer(EPriorityStandard);
        __ASSERT_ALWAYS(pS!=NULL,CCountServServer::PanicServer(ESvrCreateServer));
                
          //Install the active scheduler
        CActiveScheduler::Install(pA);
          
          // Start the server
        TInt err = pS->Start(KCountServerName);
        if (err != KErrNone)
            {
                CCountServServer::PanicServer(ESvrStartServer);
            }
        
      // Let everyone know that we are ready to
      // deal with requests.
    RThread::Rendezvous(KErrNone);
        
          // And start fielding requests from client(s).
        CActiveScheduler::Start();

      // Tidy up...     
    delete pS;
    delete pA;
    delete cleanup; 
    
          // ...although we should never get here!
        return(KErrNone);
        }


EXPORT_C TInt StartThread(RThread& aServerThread)
    {
        TInt res=KErrNone;
        
          // Create the server, if one with this name does not already exist.
        TFindServer findCountServer(KCountServerName);
        TFullName   name;
        
          // Need to check that the server exists.
        if (findCountServer.Next(name)!=KErrNone)
                {
                  // Create the thread for the server.
                res=aServerThread.Create(KCountServerName,
                        CCountServServer::ThreadFunction,
                        KDefaultStackSize,
                        KDefaultHeapSize,
                        KDefaultHeapSize,
                        NULL
                        );
                        
          // The thread has been created OK so get it started - however
          // we need to make sure that it has started before we continue.
                if (res==KErrNone)
                        {
                        TRequestStatus rendezvousStatus;
                        
                        aServerThread.SetPriority(EPriorityNormal);
                        aServerThread.Rendezvous(rendezvousStatus);
                        aServerThread.Resume();
                        User::WaitForRequest(rendezvousStatus);
                        }
                        
                  // The thread has not been created - clearly there's been a problem.
                else
                        {
                        aServerThread.Close();
                        }
                }
    return res;
    }

---