cobain.h

/*
 * cobain.h,v 1.40 2004/01/08 13:20:21 mattid Exp
 *
 * COBAIN - Communications API for EPOC Environments
 * Copyright (C) 2002-2004 Matti Dahlbom, Matti Kokkola
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Contact: Matti Dahlbom <matti@777-team.org>
 *          Matti Kokkola <matti.kokkola@iki.fi>
 */

#ifndef __COBAIN_H
#define __COBAIN_H

#include <e32base.h>
#include <e32std.h>
#include <flogger.h>
#include <bt_sock.h> // for KRFCOMM / KL2CAP constants

#include "clientservercommon.h"
#include "Log.h" // offer logging for API client

// forward declarations
class RCobainClientSession;
class CBTDriver;
class RCobainSocket;
class MNetworkDriverListener;
class CBTUtil;

// file logging info
_LIT(KClientLogdir, "cobain");
_LIT(KClientLogfile, "client.log");

class MSocketListener
{
    public:
        virtual void Data(TDesC8 &aDataBuf, RCobainSocket *aSocket) = 0;

        virtual void SocketDisconnected(RCobainSocket *aSocket) = 0;

        virtual void SocketError(TInt aError, RCobainSocket *aSocket) = 0;
};

// RCobainSocket's panic category and error codes
_LIT(KCobainSocketPanic, "RCobainSocket");

const TInt KErrCobainSocketBase = -22000;
const TInt KErrCobainSocketNullSocketListener = KErrCobainSocketBase - 1;
const TInt KErrCobainSocketClosed = KErrCobainSocketBase - 2;

class RCobainSocket : public CActive
{
    public:
        IMPORT_C void SetSocketListener(MSocketListener *aSocketListener);

        IMPORT_C void SendL(const TDesC8 *aBuffer);

        IMPORT_C void Close(TBool aImmediately = EFalse);

        IMPORT_C ~RCobainSocket();
    
    private:
        RCobainSocket(RCobainClientSession &aSession, TInt aId);
        void RunL();
        void DoCancel();
        void Receive();

        // whether this socket has been closed
        TBool iIsClosed;

        // socket id
        TInt iId;

        // reference to the client session
        RCobainClientSession &iSession;

        // the socket listener
        MSocketListener *iSocketListener;

        // receive buffer
        TBuf8<KRecvBufSize> iRecvBuf;

        friend class CNetworkPeer;
        friend class RCobainClientSession;
        friend class CConnectionListener;
};

class CNetworkPeer : public CBase
{
    public:
        IMPORT_C ~CNetworkPeer();

        IMPORT_C TDesC& GetDeviceName() const { return *iDeviceName; }

        IMPORT_C TDesC8& GetDeviceAddress() const { return *iDeviceAddress; }

        IMPORT_C TDesC& GetServiceName() const { return *iServiceName; }

        IMPORT_C RCobainSocket* ConnectL();

        IMPORT_C TProtocol GetProtocol() const { return iProtocol; }

        TSglQueLink iLink; // for use in a linked list

    private:
        CNetworkPeer(RCobainClientSession &aSession,
                     TProtocol aProtocol);

        static CNetworkPeer* NewL(RCobainClientSession &aSession,
                                  TProtocol aProtocol,
                                  TPeerData &aPeerData);
        
        void ConstructL(TPeerData &aPeerData);

        TDesC8* CopyPeerPropertiesL(TPeerData &aPeerData);

        TDes8* GetPeerProperties() const { return iProtocolSpecificPeerData; }

        void WritePeerData(TPeerData &aPeerData); 

        // peer's protocol (type)
        TProtocol iProtocol;

        // name of the peer's device
        HBufC *iDeviceName;

        // address of the peer's device (protocol dependent)
        HBufC8 *iDeviceAddress;

        // name of the service
        HBufC *iServiceName;

        // reference to session
        RCobainClientSession &iSession;

        // protocol specific peer data 
        TDes8 *iProtocolSpecificPeerData;

        friend class RCobainClientSession;
        friend class CPeerListPump;
        friend class CBTUtil;
};

typedef RPointerArray<CNetworkPeer> TPeerList;

class MConnectionListener;

// MNetworkDriver error codes
const TInt KErrDriverBase = -17500;
const TInt KErrDriverAlreadyListening = KErrDriverBase - 1;
const TInt KErrDriverNotListening = KErrDriverBase - 2;

class MNetworkDriver 
{
    public:
        virtual ~MNetworkDriver() {};

        virtual void DiscoverPeersL(TUint aServiceID, 
                                    MNetworkDriverListener *aListener) = 0;

        virtual void CancelPeerDiscovery() = 0;

        virtual TProtocol GetProtocol() = 0;

        virtual void ListenL(TUint aPort, MConnectionListener *aListener,
                             TUint aExtraInfo = KRFCOMM) = 0;

        virtual void StopListeningL() = 0;
};

class MNetworkDriverListener
{
    public:
         virtual void PeerListComplete(TPeerList *aPeerList) = 0;
         virtual void PeerListRetrievalFailed(TInt aError) = 0;
};

class MConnectionListener
{
    public:
        virtual void Accept(RCobainSocket *aSocket, MNetworkDriver *aDriver) = 0;
};

class CCobainLayer : public CBase 
{
    public:
        //##TODO## document us!
        IMPORT_C static CCobainLayer * NewL();
        IMPORT_C void Shutdown();
        IMPORT_C MNetworkDriver * GetDriverL(TProtocol aDriverProtocol);
        IMPORT_C ~CCobainLayer();

    private:
        CCobainLayer();
        void ConstructL();

        RCobainClientSession *iClientSession;
};

#endif

---