os/kernelhwsrv/userlibandfileserver/fileserver/smassstorage/inc/massstorage.h
changeset 0 bde4ae8d615e
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/kernelhwsrv/userlibandfileserver/fileserver/smassstorage/inc/massstorage.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,92 @@
     1.4 +// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// under the terms of the License "Eclipse Public License v1.0"
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +// RUsbMassStorage Client side header
    1.18 +// Implements the Symbian OS USB mass storage server RUsbMassStorage API 
    1.19 +// 
    1.20 +// WARNING: This file contains some APIs which are internal and are subject
    1.21 +//          to change without notice. Such APIs should therefore not be used
    1.22 +//          outside the Kernel and Hardware Services package.
    1.23 +//
    1.24 +
    1.25 +/**
    1.26 + @file
    1.27 + @internalTechnology
    1.28 +*/
    1.29 +
    1.30 +#ifndef __MASSSTORAGE_H__
    1.31 +#define __MASSSTORAGE_H__
    1.32 +
    1.33 +#include <e32std.h>
    1.34 +#include <usbmsshared.h>
    1.35 +
    1.36 +class RUsbMassStorage : public RSessionBase
    1.37 +/**
    1.38 + The RUsbMassStorage class implements the Symbian OS USB mass storage RUsbMassStorage API 
    1.39 + 
    1.40 + @internalTechnology
    1.41 + */
    1.42 +	{
    1.43 +public:
    1.44 +	/**
    1.45 +     Constructor
    1.46 +      
    1.47 +	 @internalTechnology
    1.48 +	 */
    1.49 +	inline RUsbMassStorage();
    1.50 +
    1.51 +	/**
    1.52 +     Extract the version of the server providing the RUsbMassStorage API
    1.53 +     
    1.54 +     @return	Version of the server
    1.55 +     @internalTechnology
    1.56 +	 */
    1.57 +	inline TVersion Version() const;
    1.58 +
    1.59 +	/**
    1.60 +     Start the mass storage transport service
    1.61 +     
    1.62 +	 @param aMsConfig	mass storage configuration info
    1.63 +	 @internalTechnology
    1.64 +	 @return KErrNone on success, otherwise system wide error code 
    1.65 +	 */
    1.66 +	inline TInt Start(const TMassStorageConfig& aMsConfig);
    1.67 +
    1.68 +	/**
    1.69 +     Stops mass storage transport service
    1.70 +     
    1.71 +	 @internalTechnology
    1.72 +	 @return KErrNone on success, otherwise system wide error code 
    1.73 +	 */
    1.74 +	inline TInt Stop();
    1.75 +	
    1.76 +	/**
    1.77 +     Shut down the Mass Storage server
    1.78 +     
    1.79 +	 @internalTechnology
    1.80 +	 @return KErrNone on success, otherwise system wide error code 
    1.81 +	 */
    1.82 +	inline TInt Shutdown();
    1.83 +	
    1.84 +	/**
    1.85 +	 Connects to mass storage file server
    1.86 +	 
    1.87 +	 @internalTechnology
    1.88 +	 @return KErrNone on success, otherwise system wide error code 
    1.89 +	 */
    1.90 +    inline TInt Connect();
    1.91 +	};
    1.92 +
    1.93 +#include <rusbmassstorage.inl>
    1.94 +
    1.95 +#endif //__MASSSTORAGE_H__