LogRecordSequence.WriteRestartArea Method

Definition

Namespace:

System.IO.Log

Assembly:

System.IO.Log.dll

Writes a restart area to the LogRecordSequence.

Overloads

WriteRestartArea(ArraySegment<Byte>)	Writes a restart area to the LogRecordSequence. This method cannot be inherited.
WriteRestartArea(IList<ArraySegment<Byte>>)	Writes a restart area to the LogRecordSequence. This method cannot be inherited.
WriteRestartArea(ArraySegment<Byte>, SequenceNumber)	Writes a restart area to the LogRecordSequence and updates the base sequence number. This method cannot be inherited.
WriteRestartArea(IList<ArraySegment<Byte>>, SequenceNumber)	Writes a restart area to the LogRecordSequence and updates the base sequence number. This method cannot be inherited.
WriteRestartArea(ArraySegment<Byte>, SequenceNumber, ReservationCollection)	Writes a restart area to the LogRecordSequence using a reservation, and updates the base sequence number. This method cannot be inherited.
WriteRestartArea(IList<ArraySegment<Byte>>, SequenceNumber, ReservationCollection)	Writes a restart area to the LogRecordSequence using a reservation, and updates the base sequence number. This method cannot be inherited.

Remarks

A restart area is used to temporarily store information containing a client's last checkpoint operation. The Common Log File System (CLFS) maintains two restart areas to guarantee that at least one valid area is always available. When a recovery is necessary, the CLFS reads its restart area and 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.

WriteRestartArea(ArraySegment<Byte>)

Writes a restart area to the LogRecordSequence. This method cannot be inherited.

public:
 virtual System::IO::Log::SequenceNumber WriteRestartArea(ArraySegment<System::Byte> data);

public System.IO.Log.SequenceNumber WriteRestartArea (ArraySegment<byte> data);

abstract member WriteRestartArea : ArraySegment<byte> -> System.IO.Log.SequenceNumber
override this.WriteRestartArea : ArraySegment<byte> -> System.IO.Log.SequenceNumber

Public Function WriteRestartArea (data As ArraySegment(Of Byte)) As SequenceNumber

Parameters

data

ArraySegment<Byte>

An array segment that will be concatenated and appended as the record.

Returns

SequenceNumber

The sequence number of the written restart area.

Implements

WriteRestartArea(ArraySegment<Byte>)

Exceptions

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.

ArgumentNullException

One or more of the arguments are null.

UnauthorizedAccessException

Access for the specified log sequence is denied by the operating system.

OutOfMemoryException

There is not enough memory to continue the execution of the program.

Remarks

A restart area is used to temporarily store information containing a client's last checkpoint operation. The Common Log File System (CLFS) maintains two restart areas to guarantee that at least one valid area is always available. When a recovery is necessary, the CLFS reads its restart area and 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.

The data in the byte array segments will be 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.

WriteRestartArea(IList<ArraySegment<Byte>>)

Writes a restart area to the LogRecordSequence. This method cannot be inherited.

public:
 virtual System::IO::Log::SequenceNumber WriteRestartArea(System::Collections::Generic::IList<ArraySegment<System::Byte>> ^ data);

public System.IO.Log.SequenceNumber WriteRestartArea (System.Collections.Generic.IList<ArraySegment<byte>> data);

abstract member WriteRestartArea : System.Collections.Generic.IList<ArraySegment<byte>> -> System.IO.Log.SequenceNumber
override this.WriteRestartArea : System.Collections.Generic.IList<ArraySegment<byte>> -> System.IO.Log.SequenceNumber

Public Function WriteRestartArea (data As IList(Of ArraySegment(Of Byte))) As SequenceNumber

Parameters

data

IList<ArraySegment<Byte>>

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

Returns

SequenceNumber

The sequence number of the written restart area.

Implements

WriteRestartArea(IList<ArraySegment<Byte>>)

Exceptions

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.

ArgumentNullException

One or more of the arguments are null.

UnauthorizedAccessException

Access for the specified log sequence is denied by the operating system.

OutOfMemoryException

There is not enough memory to continue the execution of the program.

Remarks

A restart area is used to temporarily store information containing a client's last checkpoint operation. The Common Log File System (CLFS) maintains two restart areas to guarantee that at least one valid area is always available. When a recovery is necessary, the CLFS reads its restart area and 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.

The data in the byte array segments will be 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.

WriteRestartArea(ArraySegment<Byte>, SequenceNumber)

Writes a restart area to the LogRecordSequence and updates the base sequence number. This method cannot be inherited.

public:
 virtual System::IO::Log::SequenceNumber WriteRestartArea(ArraySegment<System::Byte> data, System::IO::Log::SequenceNumber newBaseSeqNum);

public System.IO.Log.SequenceNumber WriteRestartArea (ArraySegment<byte> data, System.IO.Log.SequenceNumber newBaseSeqNum);

abstract member WriteRestartArea : ArraySegment<byte> * System.IO.Log.SequenceNumber -> System.IO.Log.SequenceNumber
override this.WriteRestartArea : ArraySegment<byte> * System.IO.Log.SequenceNumber -> System.IO.Log.SequenceNumber

Public Function WriteRestartArea (data As ArraySegment(Of Byte), newBaseSeqNum As SequenceNumber) As SequenceNumber

Parameters

data

ArraySegment<Byte>

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

newBaseSeqNum

SequenceNumber

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

Returns

SequenceNumber

The sequence number of the written restart area.

Implements

WriteRestartArea(ArraySegment<Byte>, SequenceNumber)

Exceptions

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.

Remarks

A restart area is used to temporarily store information containing a client's last checkpoint operation. The Common Log File System (CLFS) maintains two restart areas to guarantee that at least one valid area is always available. When a recovery is necessary, the CLFS reads its restart area and 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.

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.

WriteRestartArea(IList<ArraySegment<Byte>>, SequenceNumber)

Writes a restart area to the LogRecordSequence and updates the base sequence number. This method cannot be inherited.

public:
 virtual System::IO::Log::SequenceNumber WriteRestartArea(System::Collections::Generic::IList<ArraySegment<System::Byte>> ^ data, System::IO::Log::SequenceNumber newBaseSeqNum);

public System.IO.Log.SequenceNumber WriteRestartArea (System.Collections.Generic.IList<ArraySegment<byte>> data, System.IO.Log.SequenceNumber newBaseSeqNum);

abstract member WriteRestartArea : System.Collections.Generic.IList<ArraySegment<byte>> * System.IO.Log.SequenceNumber -> System.IO.Log.SequenceNumber
override this.WriteRestartArea : System.Collections.Generic.IList<ArraySegment<byte>> * System.IO.Log.SequenceNumber -> System.IO.Log.SequenceNumber

Public Function WriteRestartArea (data As IList(Of ArraySegment(Of Byte)), newBaseSeqNum As SequenceNumber) As SequenceNumber

Parameters

data

IList<ArraySegment<Byte>>

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

newBaseSeqNum

SequenceNumber

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

Returns

SequenceNumber

The sequence number of the written restart area.

Implements

WriteRestartArea(IList<ArraySegment<Byte>>, SequenceNumber)

Exceptions

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.

Remarks

A restart area is used to temporarily store information containing a client's last checkpoint operation. The Common Log File System (CLFS) maintains two restart areas to guarantee that at least one valid area is always available. When a recovery is necessary, the CLFS reads its restart area and 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.

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.

WriteRestartArea(ArraySegment<Byte>, SequenceNumber, ReservationCollection)

Writes a restart area to the LogRecordSequence using a reservation, and updates the base sequence number. This method cannot be inherited.

public:
 virtual System::IO::Log::SequenceNumber WriteRestartArea(ArraySegment<System::Byte> data, System::IO::Log::SequenceNumber newBaseSeqNum, System::IO::Log::ReservationCollection ^ reservations);

public System.IO.Log.SequenceNumber WriteRestartArea (ArraySegment<byte> data, System.IO.Log.SequenceNumber newBaseSeqNum, System.IO.Log.ReservationCollection reservations);

abstract member WriteRestartArea : ArraySegment<byte> * System.IO.Log.SequenceNumber * System.IO.Log.ReservationCollection -> System.IO.Log.SequenceNumber
override this.WriteRestartArea : ArraySegment<byte> * System.IO.Log.SequenceNumber * System.IO.Log.ReservationCollection -> System.IO.Log.SequenceNumber

Public Function WriteRestartArea (data As ArraySegment(Of Byte), newBaseSeqNum As SequenceNumber, reservations As ReservationCollection) As SequenceNumber

Parameters

data

ArraySegment<Byte>

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

newBaseSeqNum

SequenceNumber

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

reservations

ReservationCollection

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

Returns

SequenceNumber

The sequence number of the written restart area.

Implements

WriteRestartArea(ArraySegment<Byte>, SequenceNumber, ReservationCollection)

Exceptions

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.

Remarks

A restart area is used to temporarily store information containing a client's last checkpoint operation. The Common Log File System (CLFS) maintains two restart areas to guarantee that at least one valid area is always available. When a recovery is necessary, the CLFS reads its restart area and 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.

WriteRestartArea(IList<ArraySegment<Byte>>, SequenceNumber, ReservationCollection)

Writes a restart area to the LogRecordSequence using a reservation, and updates the base sequence number. This method cannot be inherited.

public:
 virtual System::IO::Log::SequenceNumber WriteRestartArea(System::Collections::Generic::IList<ArraySegment<System::Byte>> ^ data, System::IO::Log::SequenceNumber newBaseSeqNum, System::IO::Log::ReservationCollection ^ reservationCollection);

public System.IO.Log.SequenceNumber WriteRestartArea (System.Collections.Generic.IList<ArraySegment<byte>> data, System.IO.Log.SequenceNumber newBaseSeqNum, System.IO.Log.ReservationCollection reservationCollection);

abstract member WriteRestartArea : System.Collections.Generic.IList<ArraySegment<byte>> * System.IO.Log.SequenceNumber * System.IO.Log.ReservationCollection -> System.IO.Log.SequenceNumber
override this.WriteRestartArea : System.Collections.Generic.IList<ArraySegment<byte>> * System.IO.Log.SequenceNumber * System.IO.Log.ReservationCollection -> System.IO.Log.SequenceNumber

Public Function WriteRestartArea (data As IList(Of ArraySegment(Of Byte)), newBaseSeqNum As SequenceNumber, reservationCollection As ReservationCollection) As SequenceNumber

Parameters

data

IList<ArraySegment<Byte>>

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

newBaseSeqNum

SequenceNumber

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

reservationCollection

ReservationCollection

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

Returns

SequenceNumber

The sequence number of the written restart area.

Implements

WriteRestartArea(IList<ArraySegment<Byte>>, SequenceNumber, ReservationCollection)

Exceptions

ArgumentException

newBaseSeqNum is not valid for this sequence.

-or-

The specified log enumeration start sequence number is invalid.

-or-

data cannot be appended because it is larger than the maximum record size.

-or-

reservationCollection was not created by this record sequence.

ArgumentNullException

One or more of the parameters is null.

ArgumentOutOfRangeException

A new or existing archive tail or base of the active log is invalid.

-or-

newBaseSeqNum is not between the base and last sequence numbers of this sequence.

IOException

The request could not be performed because of an unexpected I/O exception.

-or-

The request could not be performed because of an I/O device error.

ObjectDisposedException

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

OutOfMemoryException

There is not enough memory to continue the execution of the program.

UnauthorizedAccessException

Access for the specified log sequence is denied by the operating system.

SequenceFullException

The record sequence is full.

Remarks

A restart area is used to temporarily store information containing a client's last checkpoint operation. The Common Log File System (CLFS) maintains two restart areas to guarantee that at least one valid area is always available. When a recovery is necessary, the CLFS reads its restart area and 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.