upnp/upnpstack_plat/upnp_utils_api/inc/upnpsessionbase.h
changeset 0 f5a58ecadc66
equal deleted inserted replaced
-1:000000000000 0:f5a58ecadc66
       
     1 /** @file
       
     2 * Copyright (c) 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 RUpnpSessionBase
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef RUPNPSESSIONBASE_H
       
    19 #define RUPNPSESSIONBASE_H
       
    20 
       
    21 #include <e32base.h>
       
    22 
       
    23 /**
       
    24  * Base class for all client side session classes used in upnp stack project
       
    25  * It provides you connecting and starting server
       
    26  *
       
    27  * Note that it should be used with server part implementation that use
       
    28  * CUpnpSymbianServerBase class.
       
    29  *
       
    30  *  @lib upnpipserversutils
       
    31  */
       
    32 class RUpnpSessionBase : public RSessionBase
       
    33     {
       
    34 protected:
       
    35 
       
    36     /**
       
    37      * Connect to the server and create a session
       
    38      *
       
    39      * @param aServerName               name of server to connect to
       
    40      * @param aServerVersion            version of server that is supported
       
    41      * @param aServerMessageSlots       number of message slots
       
    42      * @param aServerStartRetryCount    number of possible start retries to be made
       
    43      * @param aServerFileName           name of server exe file to run
       
    44      * @param aServerUid3               uid3 of server exe to run
       
    45      * @return error code
       
    46      */
       
    47     IMPORT_C TInt Connect( const TDesC& aServerName, TVersion aServerVersion,
       
    48         TInt aServerMessageSlots, TInt aServerStartRetryCount,
       
    49         const TDesC& aServerFileName, TUid aServerUid3 );
       
    50 
       
    51     };
       
    52 
       
    53 #endif // RUPNPSESSIONBASE_H