IRecordSequence.BeginWriteRestartArea Method (IList<ArraySegment<Byte>>, SequenceNumber, ReservationCollection, AsyncCallback, Object)
When overridden in a derived class, begins an asynchronous restart area write operation, using space previously reserved in the sequence.
Namespace: System.IO.Log
Assembly: System.IO.Log (in System.IO.Log.dll)
IAsyncResult BeginWriteRestartArea(
IList<ArraySegment<byte>> data,
SequenceNumber newBaseSequenceNumber,
ReservationCollection reservation,
AsyncCallback callback,
Object state
)
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.
- callback
- Type: System.AsyncCallback
An optional asynchronous callback, to be called when the restart area write is complete.
- state
- Type: System.Object
A user-provided object that distinguishes this particular asynchronous restart area write request from other requests.
Return Value
Type: System.IAsyncResultAn IAsyncResult that represents the asynchronous restart area write operation, which could still be pending.
| Exception | Condition |
|---|---|
| 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 record. |
| ObjectDisposedException | The method was called after the sequence has been disposed of. |
You should pass the IAsyncResult returned by this method to the EndWriteRestartArea method to ensure that the restart area write operation has completed and resources can be freed appropriately. If an error has occurred during an asynchronous restart area write operation, an exception is not thrown until the EndWriteRestartArea method is called with the IAsyncResult returned by this method.
Data contained in the data parameter will be concatenated into a single byte array for appending as the record. However, no provision is made for splitting data back into array segments when the record is read.
When the operation 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 ReservationCollection 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 hold the data, and that reservation will be removed from the collection.
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 EndWriteRestartArea method is called.
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.
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.
