1 // Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

     2 // All rights reserved.

     3 // This component and the accompanying materials are made available

     4 // under the terms of "Eclipse Public License v1.0"

     5 // which accompanies this distribution, and is available

     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

    14 // 

    15 // 

    16 

    17 

    18 /** 

    19  @file

    20  @internalTechnology 

    21  RUsbMscFile Client side header

    22  Implements the Symbian OS USB mass storage server RUsbMscFile API 

    23  */

    24 

    25 #ifndef USBMSCFILE_H

    26 #define USBMSCFILE_H

    27 

    28 #include <e32std.h>

    29 #include "usbmscfileshared.h"

    30 

    31 class RUsbMscFile : public RSessionBase

    32 /**

    33  The RUsbMscFile class implements the Symbian OS USB mass storage RUsbMscFile API 

    34  

    35  @internalTechnology

    36  */

    37 	{

    38 public:

    39 	/**

    40      Constructor

    41       

    42 	 @internalTechnology

    43 	 */

    44 	inline RUsbMscFile();

    45 

    46 	/**

    47      Extract the version of the server providing the RUsbMscFile API

    48      

    49      @return	Version of the server

    50      @internalTechnology

    51 	 */

    52 	inline TVersion Version() const;

    53 

    54 	/**

    55 	 * Setup a logical unit. Maps a file containing a file system image

    56 	 * to a logical Mass Storage unit. The parameter aLun is reserved for 

    57 	 * future expansion, currently only one unit with LUN = 0 is supported.

    58 	 * 

    59 	 * @param aFileName path to the file containing the file system image

    60 	 * @param aProtocol type of SCSI protocol to use

    61 	 * @param aLun logical unit number (LUN) to assign

    62      * @return KErrNone on success, otherwise system wide error code 

    63 	 */

    64 	inline TInt SetupLogicalUnit( const TDesC& aFileName, 

    65 	                              const TInt aProtocol, 

    66 	                              const TInt aLun = 0 );

    67 	/**

    68      StartL the mass storage transport service

    69      

    70 	 @param aMsConfig	mass storage configuration info

    71 	 @internalTechnology

    72 	 @return KErrNone on success, otherwise system wide error code 

    73 	 */

    74 	inline TInt Start( const TMassStorageConfig& aMsConfig );

    75 

    76 	/**

    77      Stops mass storage transport service

    78      

    79 	 @internalTechnology

    80 	 @return KErrNone on success, otherwise system wide error code 

    81 	 */

    82 	inline TInt Stop();

    83 	

    84 	/**

    85      Shut down the Mass Storage server

    86      

    87 	 @internalTechnology

    88 	 @return KErrNone on success, otherwise system wide error code 

    89 	 */

    90 	inline TInt Shutdown();

    91 	

    92 	/**

    93 	 Connects to mass storage file server

    94 	 

    95 	 @internalTechnology

    96 	 @return KErrNone on success, otherwise system wide error code 

    97 	 */

    98     inline TInt Connect();

    99     

   100 	};

   101 

   102 #include "usbmscfile.inl"

   103 

   104 #endif //USBMSCFILE_H