Export (0) Print
Expand All

IRecordSequence.WriteRestartArea Method (IList<ArraySegment<Byte>>, SequenceNumber, ReservationCollection)

When overridden in a derived class, writes a restart area to the IRecordSequence using a reservation, and updates the base sequence number.

Namespace:  System.IO.Log
Assembly:  System.IO.Log (in System.IO.Log.dll)

SequenceNumber WriteRestartArea(
	IList<ArraySegment<byte>> data,
	SequenceNumber newBaseSequenceNumber,
	ReservationCollection reservation
)

Parameters

data
Type: System.Collections.Generic.IList<ArraySegment<Byte>>

A list of byte array segments that will be concatenated and appended as the record.

newBaseSequenceNumber
Type: System.IO.Log.SequenceNumber

The new base sequence number. The specified sequence number must be greater than or equal to the current base sequence number.

reservation
Type: System.IO.Log.ReservationCollection

A ReservationCollection that contains the reservation that should be used for this restart area.

Return Value

Type: System.IO.Log.SequenceNumber
The sequence number of the written restart area.

ExceptionCondition
ArgumentException

One or more of the arguments is invalid.

IOException

An I/O error occurred while writing the restart area.

SequenceFullException

The record sequence could not make enough free space to contain the new restart area.

ObjectDisposedException

The method was called after the sequence has been disposed of.

A restart area is used to temporarily store information containing a client's last checkpoint operation. When a recovery is necessary, you can parse the restart area to retrieve all the data from the last checkpoint operation. This data initializes the transaction table, dirty pages table, and open file table so they can be used in the recovery process. A restart area can be read using the ReadRestartAreas method.

When a restart area is written, the data in the byte array segments are concatenated into a single byte array for appending as the record. No provision is made for splitting data back into array segments when the restart area is read.

If a reservation is specified, the written restart area will consume space that has been previously reserved, using a reservation contained in the collection. If the method succeeds, it will consume the smallest reservation that can contain the data, and that reservation will be removed from the collection.

When this method successfully completes, the base sequence number has been updated. All log records with sequence numbers less than the new base sequence number are inaccessible.

If a record sequence has been disposed of, or if you pass an invalid argument, exceptions are thrown immediately within this operation. Errors that occurred during an asynchronous append request, for example, a disk failure during the I/O request, will result in exceptions being thrown when the EndReserveAndAppend method is called.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft