upnp/upnpstack_plat/upnp_device_api/inc/upnpdevicedescriptionprovider.h
changeset 0 f5a58ecadc66
equal deleted inserted replaced
-1:000000000000 0:f5a58ecadc66
       
     1 /** @file
       
     2 * Copyright (c) 2005-2008 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:  Declaration of MUpnpSubscriberLibraryObserver
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef C_MUPNPDEVICEDESCRIPTIONPROVIDER_H
       
    19 #define C_MUPNPDEVICEDESCRIPTIONPROVIDER_H
       
    20 
       
    21 //INCLUDES
       
    22 #include <e32base.h>
       
    23 #include <f32file.h>
       
    24 
       
    25 //FORWARD DECLARATIONS
       
    26 class CUpnpDeviceDescriptionRequest;
       
    27 
       
    28 // CLASS DECLARATION
       
    29 /**
       
    30 *  This interface informs local device implementation owner 
       
    31 *  about incomig description request via callbacks:
       
    32 *  - OnDeviceDescription
       
    33 *  - OnServiceDescription
       
    34 *  - OnIcon
       
    35 *  If callback returns error 404 Not found is returned to 
       
    36 *  remote requestor otherwse GetFile() is invoked
       
    37 *  which has to return open hadle to description file. 
       
    38 */
       
    39 class MUpnpDeviceDescriptionProvider
       
    40 {
       
    41 public: // New functions 
       
    42    /**
       
    43     * Method is called on request of device icon 
       
    44     * @param aServiceUri service description uri
       
    45     * @param aServiceFile open handle to icon file    
       
    46     * @return System wide error code
       
    47     */    
       
    48     virtual TInt OnDeviceDescription( CUpnpDeviceDescriptionRequest& aRequest ) = 0;
       
    49 
       
    50    /**
       
    51     * Method is called on request of service description xml
       
    52     * @param aServiceUri service description uri
       
    53     * @param aServiceFile open handle to service description file
       
    54     * @return System wide error code.
       
    55     */
       
    56     virtual TInt OnServiceDescription( CUpnpDeviceDescriptionRequest& aRequest ) = 0;
       
    57    /**
       
    58     * Method is called on request of device icon 
       
    59     * @param aServiceUri service description uri
       
    60     * @param aServiceFile open handle to icon file    
       
    61     * @return System wide error code
       
    62     */    
       
    63     virtual TInt OnIcon( CUpnpDeviceDescriptionRequest& aRequest ) = 0;
       
    64     
       
    65    /**
       
    66     * Method matches uri and returs a handle to an open file 
       
    67     * @param aServiceUri service description uri
       
    68     * @param aServiceFile open handle to icon file    
       
    69     * @return System wide error code
       
    70     */    
       
    71     virtual TInt GetFile( const TDesC8& aUri, RFile& aFile ) = 0;
       
    72     
       
    73 };
       
    74 
       
    75 
       
    76 #endif  // C_MUPNPDEVICEDESCRIPTIONPROVIDER_H
       
    77 
       
    78 //End of File