os/kernelhwsrv/userlibandfileserver/fileserver/smassstorage/inc/massstorage.h
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
sl@0
     1
// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0
     2
// All rights reserved.
sl@0
     3
// This component and the accompanying materials are made available
sl@0
     4
// under the terms of the License "Eclipse Public License v1.0"
sl@0
     5
// which accompanies this distribution, and is available
sl@0
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     7
//
sl@0
     8
// Initial Contributors:
sl@0
     9
// Nokia Corporation - initial contribution.
sl@0
    10
//
sl@0
    11
// Contributors:
sl@0
    12
//
sl@0
    13
// Description:
sl@0
    14
// RUsbMassStorage Client side header
sl@0
    15
// Implements the Symbian OS USB mass storage server RUsbMassStorage API 
sl@0
    16
// 
sl@0
    17
// WARNING: This file contains some APIs which are internal and are subject
sl@0
    18
//          to change without notice. Such APIs should therefore not be used
sl@0
    19
//          outside the Kernel and Hardware Services package.
sl@0
    20
//
sl@0
    21
sl@0
    22
/**
sl@0
    23
 @file
sl@0
    24
 @internalTechnology
sl@0
    25
*/
sl@0
    26
sl@0
    27
#ifndef __MASSSTORAGE_H__
sl@0
    28
#define __MASSSTORAGE_H__
sl@0
    29
sl@0
    30
#include <e32std.h>
sl@0
    31
#include <usbmsshared.h>
sl@0
    32
sl@0
    33
class RUsbMassStorage : public RSessionBase
sl@0
    34
/**
sl@0
    35
 The RUsbMassStorage class implements the Symbian OS USB mass storage RUsbMassStorage API 
sl@0
    36
 
sl@0
    37
 @internalTechnology
sl@0
    38
 */
sl@0
    39
	{
sl@0
    40
public:
sl@0
    41
	/**
sl@0
    42
     Constructor
sl@0
    43
      
sl@0
    44
	 @internalTechnology
sl@0
    45
	 */
sl@0
    46
	inline RUsbMassStorage();
sl@0
    47
sl@0
    48
	/**
sl@0
    49
     Extract the version of the server providing the RUsbMassStorage API
sl@0
    50
     
sl@0
    51
     @return	Version of the server
sl@0
    52
     @internalTechnology
sl@0
    53
	 */
sl@0
    54
	inline TVersion Version() const;
sl@0
    55
sl@0
    56
	/**
sl@0
    57
     Start the mass storage transport service
sl@0
    58
     
sl@0
    59
	 @param aMsConfig	mass storage configuration info
sl@0
    60
	 @internalTechnology
sl@0
    61
	 @return KErrNone on success, otherwise system wide error code 
sl@0
    62
	 */
sl@0
    63
	inline TInt Start(const TMassStorageConfig& aMsConfig);
sl@0
    64
sl@0
    65
	/**
sl@0
    66
     Stops mass storage transport service
sl@0
    67
     
sl@0
    68
	 @internalTechnology
sl@0
    69
	 @return KErrNone on success, otherwise system wide error code 
sl@0
    70
	 */
sl@0
    71
	inline TInt Stop();
sl@0
    72
	
sl@0
    73
	/**
sl@0
    74
     Shut down the Mass Storage server
sl@0
    75
     
sl@0
    76
	 @internalTechnology
sl@0
    77
	 @return KErrNone on success, otherwise system wide error code 
sl@0
    78
	 */
sl@0
    79
	inline TInt Shutdown();
sl@0
    80
	
sl@0
    81
	/**
sl@0
    82
	 Connects to mass storage file server
sl@0
    83
	 
sl@0
    84
	 @internalTechnology
sl@0
    85
	 @return KErrNone on success, otherwise system wide error code 
sl@0
    86
	 */
sl@0
    87
    inline TInt Connect();
sl@0
    88
	};
sl@0
    89
sl@0
    90
#include <rusbmassstorage.inl>
sl@0
    91
sl@0
    92
#endif //__MASSSTORAGE_H__