os/persistentdata/persistentstorage/store/USTRM/US_HOST.CPP
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
sl@0
     1
// Copyright (c) 1998-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 "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
//
sl@0
    15
sl@0
    16
#include "US_STD.H"
sl@0
    17
sl@0
    18
#define UNUSED_VAR(a) a = a
sl@0
    19
sl@0
    20
EXPORT_C TInt TStreamMark::ReadL(TStreamExchange& aHost,TDes8& aDes,TRequestStatus& aStatus)
sl@0
    21
//
sl@0
    22
// Read asynchronously.
sl@0
    23
//
sl@0
    24
	{
sl@0
    25
	return aHost.DoReadL(aDes,aDes.MaxLength(),aStatus,*this);
sl@0
    26
	}
sl@0
    27
sl@0
    28
EXPORT_C TInt TStreamMark::WriteL(TStreamExchange& aHost,const TDesC8& aDes,TRequestStatus& aStatus)
sl@0
    29
/** Writes data, asynchronously, from the specified descriptor into the shared 
sl@0
    30
stream.
sl@0
    31
sl@0
    32
The maximum number of bytes to be written is the value of the maximum length 
sl@0
    33
of the descriptor.
sl@0
    34
sl@0
    35
If the function leaves, then no write request will have been initiated.
sl@0
    36
sl@0
    37
@param aHost The object that manages shared streaming.
sl@0
    38
@param aDes The source descriptor for the data to be written into the shared 
sl@0
    39
stream.
sl@0
    40
@param aStatus The request status that indicates the completion status of this 
sl@0
    41
asynchronous request.
sl@0
    42
@return The maximum number of bytes to be written, as used in this request. 
sl@0
    43
This can be different to the maximum length of the descriptor; this is dependent 
sl@0
    44
on the implementation. */
sl@0
    45
	{
sl@0
    46
	return aHost.DoWriteL(aDes,aDes.Length(),aStatus,*this);
sl@0
    47
	}
sl@0
    48
sl@0
    49
EXPORT_C MStreamBuf* TStreamExchange::Host()
sl@0
    50
/** Gets a pointer to the stream buffer that acts as the shared host.
sl@0
    51
sl@0
    52
The function refreshes the active read/write marks and gives the caller exclusive 
sl@0
    53
use of the shared host.
sl@0
    54
sl@0
    55
@return A pointer to a stream buffer that acts as shared host. */
sl@0
    56
	{
sl@0
    57
	__ASSERT_DEBUG((iRMrk==NULL||iRMrk!=iWMrk&&iRMrk->IsTracking(iRMrk))&&(iWMrk==NULL||iWMrk->IsTracking(iWMrk)),User::Invariant());
sl@0
    58
	if (iRMrk!=NULL)
sl@0
    59
		{
sl@0
    60
		TRAPD(ignore,*iRMrk=Buf().TellL(MStreamBuf::ERead));
sl@0
    61
        UNUSED_VAR(ignore);
sl@0
    62
		iRMrk=NULL;
sl@0
    63
		}
sl@0
    64
	if (iWMrk!=NULL)
sl@0
    65
		{
sl@0
    66
		TRAPD(ignore,*iWMrk=Buf().TellL(MStreamBuf::EWrite));
sl@0
    67
        UNUSED_VAR(ignore);
sl@0
    68
		iWMrk=NULL;
sl@0
    69
		}
sl@0
    70
	return iHost;
sl@0
    71
	}
sl@0
    72
sl@0
    73
EXPORT_C MStreamBuf* TStreamExchange::HostL()
sl@0
    74
/** Gets a pointer to the stream buffer that acts as the shared host, and leaves 
sl@0
    75
if this object is not active.
sl@0
    76
sl@0
    77
The function refreshes the active read/write marks and gives the caller exclusive 
sl@0
    78
use of the shared host.
sl@0
    79
sl@0
    80
@return A pointer to a stream buffer that acts as shared host.
sl@0
    81
@see IsActive() */
sl@0
    82
	{
sl@0
    83
	MStreamBuf* host=Host();
sl@0
    84
	if (host==NULL)
sl@0
    85
		__LEAVE(KErrNotReady);
sl@0
    86
	return host;
sl@0
    87
	}
sl@0
    88
sl@0
    89
EXPORT_C void TStreamExchange::Release()
sl@0
    90
/** Releases the reference to the shared host, and drops any active read or write 
sl@0
    91
marks. */
sl@0
    92
	{
sl@0
    93
	__ASSERT_DEBUG((iRMrk==NULL||iRMrk!=iWMrk&&iRMrk->IsTracking(iRMrk))&&(iWMrk==NULL||iWMrk->IsTracking(iWMrk)),User::Invariant());
sl@0
    94
	iHost=NULL;
sl@0
    95
	iRMrk=NULL;
sl@0
    96
	iWMrk=NULL;
sl@0
    97
	}
sl@0
    98
sl@0
    99
EXPORT_C TInt TStreamExchange::SizeL() const
sl@0
   100
/** Gets the size of the shared host buffer.
sl@0
   101
sl@0
   102
@return The size of the shared host buffer. */
sl@0
   103
	{
sl@0
   104
	return BufL().SizeL();
sl@0
   105
	}
sl@0
   106
sl@0
   107
EXPORT_C TBool TStreamExchange::RefersTo(const TStreamMark& aMark)
sl@0
   108
//
sl@0
   109
// Return whether aMark is referred to.
sl@0
   110
//
sl@0
   111
	{
sl@0
   112
	__ASSERT_DEBUG((iRMrk==NULL||iRMrk!=iWMrk&&iRMrk->IsTracking(iRMrk))&&(iWMrk==NULL||iWMrk->IsTracking(iWMrk)),User::Invariant());
sl@0
   113
	return iRMrk==aMark||iWMrk==aMark;
sl@0
   114
	}
sl@0
   115
sl@0
   116
EXPORT_C void TStreamExchange::Drop(const TStreamMark& aMark)
sl@0
   117
//
sl@0
   118
// Drop any reference to aMark.
sl@0
   119
//
sl@0
   120
	{
sl@0
   121
	__ASSERT_DEBUG((iRMrk==NULL||iRMrk!=iWMrk&&iRMrk->IsTracking(iRMrk))&&(iWMrk==NULL||iWMrk->IsTracking(iWMrk)),User::Invariant());
sl@0
   122
	if (iRMrk==aMark)
sl@0
   123
		iRMrk=NULL;
sl@0
   124
	else if (iWMrk==aMark)
sl@0
   125
		iWMrk=NULL;
sl@0
   126
	}
sl@0
   127
sl@0
   128
EXPORT_C void TStreamExchange::GetL(TStreamMark& aMark)
sl@0
   129
//
sl@0
   130
// Refresh and drop any reference to aMark.
sl@0
   131
//
sl@0
   132
	{
sl@0
   133
	__ASSERT_DEBUG((iRMrk==NULL||iRMrk!=iWMrk&&iRMrk->IsTracking(iRMrk))&&(iWMrk==NULL||iWMrk->IsTracking(iWMrk)),User::Invariant());
sl@0
   134
	if (iRMrk==aMark)
sl@0
   135
		{
sl@0
   136
		iRMrk=NULL;
sl@0
   137
		aMark=Buf().TellL(MStreamBuf::ERead);
sl@0
   138
		}
sl@0
   139
	else if (iWMrk==aMark)
sl@0
   140
		{
sl@0
   141
		iWMrk=NULL;
sl@0
   142
		aMark=Buf().TellL(MStreamBuf::EWrite);
sl@0
   143
		}
sl@0
   144
	}
sl@0
   145
sl@0
   146
EXPORT_C TInt TStreamExchange::DoReadL(TAny* aPtr,TInt aMaxLength,TStreamMark& aMark)
sl@0
   147
//
sl@0
   148
// Read up to aMaxLength bytes starting at aMark.
sl@0
   149
//
sl@0
   150
	{
sl@0
   151
	__ASSERT_DEBUG(iWMrk==NULL||iWMrk!=iRMrk&&iWMrk->IsTracking(iWMrk),User::Invariant());
sl@0
   152
	if (iRMrk!=aMark)
sl@0
   153
		return PrepareAndReadL(aPtr,aMaxLength,aMark);
sl@0
   154
//
sl@0
   155
	__ASSERT_DEBUG(aMark.IsTracking(iRMrk),User::Invariant());
sl@0
   156
	iRMrk=NULL;
sl@0
   157
	TInt len=Buf().ReadL(aPtr,aMaxLength);
sl@0
   158
	iRMrk=aMark;
sl@0
   159
	return len;
sl@0
   160
	}
sl@0
   161
sl@0
   162
EXPORT_C TInt TStreamExchange::DoReadL(TDes8& aDes,TInt aMaxLength,TRequestStatus& aStatus,TStreamMark& aMark)
sl@0
   163
//
sl@0
   164
// Read up to aMaxLength bytes asynchronously.
sl@0
   165
//
sl@0
   166
	{
sl@0
   167
	__ASSERT_DEBUG(iWMrk==NULL||iWMrk!=iRMrk&&iWMrk->IsTracking(iWMrk),User::Invariant());
sl@0
   168
	if (iRMrk!=aMark)
sl@0
   169
		return PrepareAndReadL(aDes,aMaxLength,aStatus,aMark);
sl@0
   170
//
sl@0
   171
	__ASSERT_DEBUG(aMark.IsTracking(iRMrk),User::Invariant());
sl@0
   172
	iRMrk=NULL;
sl@0
   173
	TInt len=Buf().ReadL(aDes,aMaxLength,aStatus);
sl@0
   174
	iRMrk=aMark;
sl@0
   175
	return len;
sl@0
   176
	}
sl@0
   177
sl@0
   178
EXPORT_C TStreamTransfer TStreamExchange::DoReadL(MStreamInput& anInput,TStreamTransfer aTransfer,TStreamMark& aMark)
sl@0
   179
//
sl@0
   180
// Push up to aTransfer bytes into anInput, starting at aMark.
sl@0
   181
//
sl@0
   182
	{
sl@0
   183
	__ASSERT_DEBUG(iWMrk==NULL||iWMrk!=iRMrk&&iWMrk->IsTracking(iWMrk),User::Invariant());
sl@0
   184
	if (iRMrk!=aMark)
sl@0
   185
		return PrepareAndReadL(anInput,aTransfer,aMark);
sl@0
   186
//
sl@0
   187
	__ASSERT_DEBUG(aMark.IsTracking(iRMrk),User::Invariant());
sl@0
   188
	iRMrk=NULL;
sl@0
   189
	TStreamTransfer trans=Buf().ReadL(anInput,aTransfer);
sl@0
   190
	iRMrk=aMark;
sl@0
   191
	return trans;
sl@0
   192
	}
sl@0
   193
sl@0
   194
EXPORT_C void TStreamExchange::DoWriteL(const TAny* aPtr,TInt aLength,TStreamMark& aMark)
sl@0
   195
//
sl@0
   196
// Write aLength bytes starting at aMark.
sl@0
   197
//
sl@0
   198
	{
sl@0
   199
	__ASSERT_DEBUG(iRMrk==NULL||iRMrk!=iWMrk&&iRMrk->IsTracking(iRMrk),User::Invariant());
sl@0
   200
	if (iWMrk==aMark)
sl@0
   201
		{
sl@0
   202
		__ASSERT_DEBUG(aMark.IsTracking(iWMrk),User::Invariant());
sl@0
   203
		iWMrk=NULL;
sl@0
   204
		Buf().WriteL(aPtr,aLength);
sl@0
   205
		iWMrk=aMark;
sl@0
   206
		}
sl@0
   207
	else
sl@0
   208
		PrepareAndWriteL(aPtr,aLength,aMark);
sl@0
   209
	}
sl@0
   210
sl@0
   211
EXPORT_C TInt TStreamExchange::DoWriteL(const TDesC8& aDes,TInt aMaxLength,TRequestStatus& aStatus,TStreamMark& aMark)
sl@0
   212
//
sl@0
   213
// Write up to aMaxLength bytes asynchronously.
sl@0
   214
//
sl@0
   215
	{
sl@0
   216
	__ASSERT_DEBUG(iRMrk==NULL||iRMrk!=iWMrk&&iRMrk->IsTracking(iRMrk),User::Invariant());
sl@0
   217
	if (iWMrk!=aMark)
sl@0
   218
		return PrepareAndWriteL(aDes,aMaxLength,aStatus,aMark);
sl@0
   219
//
sl@0
   220
	__ASSERT_DEBUG(aMark.IsTracking(iWMrk),User::Invariant());
sl@0
   221
	iWMrk=NULL;
sl@0
   222
	TInt len=Buf().WriteL(aDes,aMaxLength,aStatus);
sl@0
   223
	iWMrk=aMark;
sl@0
   224
	return len;
sl@0
   225
	}
sl@0
   226
sl@0
   227
EXPORT_C TStreamTransfer TStreamExchange::DoWriteL(MStreamOutput& anOutput,TStreamTransfer aTransfer,TStreamMark& aMark)
sl@0
   228
//
sl@0
   229
// Pull up to aTransfer bytes from anOutput, starting at aMark.
sl@0
   230
//
sl@0
   231
	{
sl@0
   232
	__ASSERT_DEBUG(iRMrk==NULL||iRMrk!=iWMrk&&iRMrk->IsTracking(iRMrk),User::Invariant());
sl@0
   233
	if (iWMrk!=aMark)
sl@0
   234
		return PrepareAndWriteL(anOutput,aTransfer,aMark);
sl@0
   235
//
sl@0
   236
	__ASSERT_DEBUG(aMark.IsTracking(iWMrk),User::Invariant());
sl@0
   237
	iWMrk=NULL;
sl@0
   238
	TStreamTransfer trans=Buf().WriteL(anOutput,aTransfer);
sl@0
   239
	iWMrk=aMark;
sl@0
   240
	return trans;
sl@0
   241
	}
sl@0
   242
sl@0
   243
EXPORT_C TStreamPos TStreamExchange::DoSeekL(TStreamMark& aMark,TStreamLocation aLocation,TInt anOffset)
sl@0
   244
//
sl@0
   245
// Position aMark at anOffset from aLocation.
sl@0
   246
//
sl@0
   247
	{
sl@0
   248
	__ASSERT_DEBUG((iRMrk==NULL||iRMrk!=iWMrk&&iRMrk->IsTracking(iRMrk))&&(iWMrk==NULL||iWMrk->IsTracking(iWMrk)),User::Invariant());
sl@0
   249
	if (iRMrk==aMark)
sl@0
   250
		{
sl@0
   251
		iRMrk=NULL;
sl@0
   252
		TStreamPos pos=Buf().SeekL(MStreamBuf::ERead,aLocation,anOffset);
sl@0
   253
		iRMrk=aMark;
sl@0
   254
		return pos;
sl@0
   255
		}
sl@0
   256
//
sl@0
   257
	if (iWMrk==aMark)
sl@0
   258
		{
sl@0
   259
		iWMrk=NULL;
sl@0
   260
		TStreamPos pos=Buf().SeekL(MStreamBuf::EWrite,aLocation,anOffset);
sl@0
   261
		iWMrk=aMark;
sl@0
   262
		return pos;
sl@0
   263
		}
sl@0
   264
//
sl@0
   265
	return MarkSeekL(aMark,aLocation,anOffset);
sl@0
   266
	}
sl@0
   267
sl@0
   268
void TStreamExchange::PrepareForReadingL(TStreamMark& aMark)
sl@0
   269
//
sl@0
   270
// Prepare the host buffer to start reading at aMark.
sl@0
   271
//
sl@0
   272
	{
sl@0
   273
	__ASSERT_DEBUG(iRMrk==NULL||iRMrk->IsTracking(iRMrk),User::Invariant());
sl@0
   274
	if (iWMrk==aMark)
sl@0
   275
		{
sl@0
   276
		iWMrk=NULL;
sl@0
   277
		aMark=Buf().TellL(MStreamBuf::EWrite);
sl@0
   278
		}
sl@0
   279
	else if (aMark.IsEmpty())
sl@0
   280
		__LEAVE(KErrNotReady);
sl@0
   281
//
sl@0
   282
	if (iRMrk!=NULL)
sl@0
   283
		{
sl@0
   284
		TRAPD(ignore,*iRMrk=Buf().TellL(MStreamBuf::ERead));
sl@0
   285
        UNUSED_VAR(ignore);
sl@0
   286
		iRMrk=NULL;
sl@0
   287
		}
sl@0
   288
//
sl@0
   289
	TStreamPos pos=aMark.Position();
sl@0
   290
	aMark.Track(iRMrk);
sl@0
   291
	BufL().SeekL(MStreamBuf::ERead,pos);
sl@0
   292
	}
sl@0
   293
sl@0
   294
void TStreamExchange::PrepareForWritingL(TStreamMark& aMark)
sl@0
   295
//
sl@0
   296
// Prepare the host buffer to start writing at aMark.
sl@0
   297
//
sl@0
   298
	{
sl@0
   299
	__ASSERT_DEBUG(iWMrk==NULL||iWMrk->IsTracking(iWMrk),User::Invariant());
sl@0
   300
	if (iRMrk==aMark)
sl@0
   301
		{
sl@0
   302
		iRMrk=NULL;
sl@0
   303
		aMark=Buf().TellL(MStreamBuf::ERead);
sl@0
   304
		}
sl@0
   305
	else if (aMark.IsEmpty())
sl@0
   306
		__LEAVE(KErrNotReady);
sl@0
   307
//
sl@0
   308
	if (iWMrk!=NULL)
sl@0
   309
		{
sl@0
   310
		TRAPD(ignore,*iWMrk=Buf().TellL(MStreamBuf::EWrite));
sl@0
   311
        UNUSED_VAR(ignore);
sl@0
   312
		iWMrk=NULL;
sl@0
   313
		}
sl@0
   314
//
sl@0
   315
	TStreamPos pos=aMark.Position();
sl@0
   316
	aMark.Track(iWMrk);
sl@0
   317
	BufL().SeekL(MStreamBuf::EWrite,pos);
sl@0
   318
	}
sl@0
   319
sl@0
   320
TInt TStreamExchange::PrepareAndReadL(TAny* aPtr,TInt aMaxLength,TStreamMark& aMark)
sl@0
   321
	{
sl@0
   322
	PrepareForReadingL(aMark);
sl@0
   323
	TInt len=Buf().ReadL(aPtr,aMaxLength);
sl@0
   324
	iRMrk=aMark;
sl@0
   325
	return len;
sl@0
   326
	}
sl@0
   327
sl@0
   328
TInt TStreamExchange::PrepareAndReadL(TDes8& aDes,TInt aMaxLength,TRequestStatus& aStatus,TStreamMark& aMark)
sl@0
   329
	{
sl@0
   330
	PrepareForReadingL(aMark);
sl@0
   331
	TInt len=Buf().ReadL(aDes,aMaxLength,aStatus);
sl@0
   332
	iRMrk=aMark;
sl@0
   333
	return len;
sl@0
   334
	}
sl@0
   335
sl@0
   336
TStreamTransfer TStreamExchange::PrepareAndReadL(MStreamInput& anInput,TStreamTransfer aTransfer,TStreamMark& aMark)
sl@0
   337
	{
sl@0
   338
	PrepareForReadingL(aMark);
sl@0
   339
	TStreamTransfer trans=Buf().ReadL(anInput,aTransfer);
sl@0
   340
	iRMrk=aMark;
sl@0
   341
	return trans;
sl@0
   342
	}
sl@0
   343
sl@0
   344
void TStreamExchange::PrepareAndWriteL(const TAny* aPtr,TInt aLength,TStreamMark& aMark)
sl@0
   345
	{
sl@0
   346
	PrepareForWritingL(aMark);
sl@0
   347
	Buf().WriteL(aPtr,aLength);
sl@0
   348
	iWMrk=aMark;
sl@0
   349
	}
sl@0
   350
sl@0
   351
TInt TStreamExchange::PrepareAndWriteL(const TDesC8& aDes,TInt aMaxLength,TRequestStatus& aStatus,TStreamMark& aMark)
sl@0
   352
	{
sl@0
   353
	PrepareForWritingL(aMark);
sl@0
   354
	TInt len=Buf().WriteL(aDes,aMaxLength,aStatus);
sl@0
   355
	iWMrk=aMark;
sl@0
   356
	return len;
sl@0
   357
	}
sl@0
   358
sl@0
   359
TStreamTransfer TStreamExchange::PrepareAndWriteL(MStreamOutput& anOutput,TStreamTransfer aTransfer,TStreamMark& aMark)
sl@0
   360
	{
sl@0
   361
	PrepareForWritingL(aMark);
sl@0
   362
	TStreamTransfer trans=Buf().WriteL(anOutput,aTransfer);
sl@0
   363
	iWMrk=aMark;
sl@0
   364
	return trans;
sl@0
   365
	}
sl@0
   366
sl@0
   367
TStreamPos TStreamExchange::MarkSeekL(TStreamMark& aMark,TStreamLocation aLocation,TInt anOffset)
sl@0
   368
	{
sl@0
   369
	if (aLocation==EStreamMark)
sl@0
   370
		{
sl@0
   371
		if (aMark.IsEmpty())
sl@0
   372
			__LEAVE(KErrNotReady);
sl@0
   373
//
sl@0
   374
		aLocation=EStreamBeginning;
sl@0
   375
		anOffset+=aMark.Position().Offset();
sl@0
   376
		}
sl@0
   377
	aMark.Clear();
sl@0
   378
	TStreamPos pos=BufL().SeekL(0,aLocation,anOffset);
sl@0
   379
	aMark=pos;
sl@0
   380
	return pos;
sl@0
   381
	}
sl@0
   382
sl@0
   383
EXPORT_C void TStreamMark::__DbgChkPos(TStreamPos aPos)
sl@0
   384
//
sl@0
   385
// Check for a negative position.
sl@0
   386
//
sl@0
   387
	{
sl@0
   388
	__ASSERT_ALWAYS(aPos>=KStreamBeginning,Panic(EStreamPosInvalid));
sl@0
   389
	}
sl@0
   390