os/kernelhwsrv/userlibandfileserver/fileserver/shostmassstorage/server/protocol/include/mblocktransferprotocol.h
author sl@SLION-WIN7.fritz.box
Fri, 15 Jun 2012 03:10:57 +0200
changeset 0 bde4ae8d615e
permissions -rw-r--r--
First public contribution.
sl@0
     1
// Copyright (c) 2008-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
// BOT Protocol layer for USB Mass Storage Class
sl@0
    15
// 
sl@0
    16
//
sl@0
    17
sl@0
    18
/**
sl@0
    19
 @file
sl@0
    20
 @internalTechnology
sl@0
    21
*/
sl@0
    22
sl@0
    23
#ifndef MBLOCKTRANSFERPROTOCOL_H
sl@0
    24
#define MBLOCKTRANSFERPROTOCOL_H
sl@0
    25
sl@0
    26
/**
sl@0
    27
Interface class to be provided by the Protocol layer. The interface methods are
sl@0
    28
used by TBlockTransfer class which manages block read and block writes of the
sl@0
    29
data to be transferred.
sl@0
    30
*/
sl@0
    31
class MBlockTransferProtocol
sl@0
    32
    {
sl@0
    33
public:
sl@0
    34
    /**
sl@0
    35
    Read a block of data aligned to block boundary.
sl@0
    36
sl@0
    37
    @param aPos The position aligned to block boundary
sl@0
    38
    @param aBuf The buffer to copy the data into
sl@0
    39
    @param aLength The Length in bytes, a multiple of the block length
sl@0
    40
    */
sl@0
    41
    virtual void BlockReadL(TUint64 aPos, TDes8& aBuf, TInt aLength) = 0;
sl@0
    42
sl@0
    43
    /**
sl@0
    44
    Write a block of data aligned to block boundary.
sl@0
    45
sl@0
    46
    @param aPos The position aligned to block boundary
sl@0
    47
    @param aBuf The buffer containing the data to write
sl@0
    48
    @param aOffset The offset into the buffer to the start of the block
sl@0
    49
    @param aLength The length in bytes, must be a multiple of the block length
sl@0
    50
    */
sl@0
    51
    virtual void BlockWriteL(TUint64 aPos, TDesC8& aBuf, TUint aOffset, TInt aLength) = 0;
sl@0
    52
    };
sl@0
    53
sl@0
    54
#endif // MBLOCKTRANSFERPROTOCOL_H
sl@0
    55