examples/SFExamples/RockPaperScissorsGameSourceCode_S60/RPS/inc/BluetoothResponder.h

/*
Copyright (c) 2002-2011 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:  CBluetoothResponder has been implemented as a state machine that incapsulates all
                the BT stack parts that are responsible for advertising the BT service using the SDP server,
                setting BT security, listening for an incoming connection and transferring data to/from a connected
                remote device (Master). CBluetoothResponder acts as the Slave part in a multiplayer game.
 
                The CBluetoothResponder's state machine includes the following operations:
                1) Finding an available RFCOMM's port
                2) Binding the BT socket to the RFCOMM's port
                3) Advertising the RPS server using the SDP server
                4) Setting BT security
                5) Listening for an incoming connection (Master connection)
                6) Both sending/receiving data to/from the remote device (Master)
                7) Callbacks to report to the App's engine the state machine error and completion of events such as listening
                   for connection, connection completed, report data, sending data completed.
                   
                Note that if at any stage we receive an error then the state machine is reset to the EIdle
                state and all resources previously allocated are closed.
 
*/



#ifndef __BLUETOOTHRESPONDER_H__
#define __BLUETOOTHRESPONDER_H__

// INCLUDES
#include <bt_sock.h>
#include <btmanclient.h>
#include <btsdp.h>
#include "BluetoothSocketWriterReader.h"
#include "CommonInterfaces.h"

// FORWARD DECLARATIONS
class CSocketReader;
class CSocketWriter;


class CBluetoothServiceAdvertiser;


// CLASS DECLARATION
class CBluetoothResponder : public CBluetoothConnectionBase, 
                                                        public MBluetoothServiceAdvertiserObserver,
                                                        public MSocketWriterReaderObserver
    {
public:
        enum TResponderState 
            {
            EIdle,                                      //State Machine's entry point
            EFindingAvailablePort,      //Finding an available RFCOMM's port
            EBinding,                           //Binding the listening socket to the BT device address and RFCOMM's port
            EAdvertising,                       //Advertising the service into SDP's database
            ERegisteringService,        //Setting the BT security
            EListening,                         //Listening for incoming connection
            EWaitingForData,            //Waiting for incoming data
            ESendingData,                       //Sending data to the remote BT device
            };

public:
    static CBluetoothResponder* NewL(MBluetoothObserver& aRespObs, RSocketServ& aSocketServer);

    ~CBluetoothResponder();
        
        //From MBluetoothServiceAdvertiserObserver
        void ReportAdvertiserErr(TInt aError);
        
        void AdvertiserComplete();
        
        //From MSocketWriterReaderObserver
        void WriteComplete(TInt aError);
        
        void ReportData(const TDesC8& aData, TInt aError);

        //From CBluetoothConnectionBase
        void SendData(const TDesC8& aData);

        void StartL();
        
private:
    CBluetoothResponder(MBluetoothObserver& aRespObs, RSocketServ& aSocketServer);

    void ConstructL();
    
        // From CActive
        virtual void RunL();
        
        virtual void DoCancel();
        
        TInt RunError(TInt aError);
        
        void SelfComplete();
        
        void FindAvailablePortL();
        
        void BindToPortL();
        
        void RegisterService();
        
        void ListenL();
        
        void WaitForData();

private:
        MBluetoothObserver& iRespObs;
        
        RSocketServ& iSocketServer;
        
        TResponderState iState;
        
        TInt iPort;
        
        RSocket iListeningSocket;
        
        RSocket iAcceptingSocket;
        
        TBTSockAddr iBtSocketAddr;
        
        CBluetoothServiceAdvertiser* iServiceAdvertiser;
        
        CSocketReader* iBtSocketReader;
        
        CSocketWriter* iBtSocketWriter;
        
        TBTServiceSecurity iBtSecurity;
   };

#endif // __BLUETOOTHRESPONDER_H__

---