services/terminalmodeservice_plat/inc/upnptmserverdeviceinfo.h
branchRCL_3
changeset 10 594d15129e2c
parent 9 5c72fd91570d
equal deleted inserted replaced
9:5c72fd91570d 10:594d15129e2c
     1 /**
       
     2 * Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description: CUpnpTmServerDeviceInfo class declaration
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef __UPNPTMSERVERDEVICEINFO_H__
       
    19 #define __UPNPTMSERVERDEVICEINFO_H__
       
    20 
       
    21 
       
    22 // INCLUDES
       
    23 #include <e32base.h>
       
    24 #include <upnpterminalmodeicon.h>
       
    25 
       
    26 /**
       
    27 * This class represents device-specific parameters associated with 
       
    28 * Terminal Mode Server Device
       
    29 */
       
    30 
       
    31 class CUpnpTmServerDeviceInfo: public CBase
       
    32     {
       
    33 public: 
       
    34 	/**
       
    35     * Standard Symbian Two-phased constructor. 
       
    36     * @param aIapId IAP ID. 32 bit unsigned integer. IAP stands  for 
       
    37     *              internet access point.It is mandatory to set IAP ID
       
    38     *               
       
    39     */  
       
    40     IMPORT_C static CUpnpTmServerDeviceInfo* NewL( TUint32 aIapId );
       
    41     /**
       
    42      * Method to set the icon information associated with the Terminal Mode
       
    43      * Server Device. It provides device icon information to the TM Sevice.
       
    44      * @param aDeviceIcon Pointer to TM Icon object.
       
    45      *                    Ownership of the object is passed.
       
    46      * @see CUpnpTerminalModeIcon
       
    47      */
       
    48     IMPORT_C void AddDeviceIconL( CUpnpTerminalModeIcon* aDeviceIcon );
       
    49     /**
       
    50      * Method to set the Nokia specific additional information
       
    51      * about the terminal mode server device.
       
    52      * The entire deviceInfo element should as an xml formatted buffer should
       
    53      * be provided as an input.
       
    54      * The device info value is opaque to the TM Service.
       
    55      * @param aDeviceInfo XML formatted buffer containing deviceInfo element.
       
    56      */
       
    57     IMPORT_C void SetDeviceInfoL( const TDesC8& aDeviceInfo );
       
    58 	/**
       
    59 	* Method to set Bluetooth  MAC address of the TM server device. 
       
    60 	* If this value is populated then it means that the device 
       
    61     *                         supports Bluetooth communication
       
    62 	* @param aBtAddress Bt MAC address
       
    63 	*/
       
    64     IMPORT_C void SetBtAddressL( const TDesC8& aBtAddress );
       
    65     /**
       
    66     * A setter to indicate that server device is able to initiate
       
    67     * Bluetooth connection to client or not.
       
    68     * @param aStartConn Boolean value
       
    69     */
       
    70     inline void SetStartConn( TBool aStartConn );
       
    71 	/**
       
    72 	* inlined "getter" methods for Terminal Mode Service's use.
       
    73 	*/
       
    74     inline TUint32 IapId()const;
       
    75     inline const RPointerArray<CUpnpTerminalModeIcon>& DeviceIconList()const;
       
    76     inline const TDesC8& DeviceInfo( )const;
       
    77     inline const TDesC8& BtAddress( )const;
       
    78     inline TBool StartConn()const;       
       
    79     ~CUpnpTmServerDeviceInfo();
       
    80     
       
    81 private: 
       
    82     CUpnpTmServerDeviceInfo( );
       
    83     void ConstructL( TUint32 aIapId );
       
    84 
       
    85 private:
       
    86     TUint32                                 iIapId;
       
    87     HBufC8*                                 iDeviceInfo;
       
    88     HBufC8*                                 iBtAddr;
       
    89     TBool                                   iStartConnValue;
       
    90     RPointerArray<CUpnpTerminalModeIcon>    iDeviceIconList;
       
    91     };
       
    92 
       
    93 #include <upnptmserverdeviceinfo.inl>
       
    94 
       
    95 #endif // __UPNPTMSERVERDEVICEINFO_H__
       
    96 
       
    97 
       
    98 // End of File