LogRecordSequence.BeginWriteRestartArea Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Begins an asynchronous restart area write operation.
Overloads
| BeginWriteRestartArea(IList<ArraySegment<Byte>>, SequenceNumber, ReservationCollection, AsyncCallback, Object) |
Begins an asynchronous restart area write operation, using space previously reserved in the sequence. This method cannot be inherited. |
| BeginWriteRestartArea(ArraySegment<Byte>, SequenceNumber, ReservationCollection, AsyncCallback, Object) |
Begins an asynchronous restart area write operation, using space previously reserved in the sequence. This method cannot be inherited. |
BeginWriteRestartArea(IList<ArraySegment<Byte>>, SequenceNumber, ReservationCollection, AsyncCallback, Object)
Begins an asynchronous restart area write operation, using space previously reserved in the sequence. This method cannot be inherited.
public:
virtual IAsyncResult ^ BeginWriteRestartArea(System::Collections::Generic::IList<ArraySegment<System::Byte>> ^ data, System::IO::Log::SequenceNumber newBaseSeqNum, System::IO::Log::ReservationCollection ^ reservationCollection, AsyncCallback ^ callback, System::Object ^ state);public IAsyncResult BeginWriteRestartArea (System.Collections.Generic.IList<ArraySegment<byte>> data, System.IO.Log.SequenceNumber newBaseSeqNum, System.IO.Log.ReservationCollection reservationCollection, AsyncCallback callback, object state);abstract member BeginWriteRestartArea : System.Collections.Generic.IList<ArraySegment<byte>> * System.IO.Log.SequenceNumber * System.IO.Log.ReservationCollection * AsyncCallback * obj -> IAsyncResult
override this.BeginWriteRestartArea : System.Collections.Generic.IList<ArraySegment<byte>> * System.IO.Log.SequenceNumber * System.IO.Log.ReservationCollection * AsyncCallback * obj -> IAsyncResultPublic Function BeginWriteRestartArea (data As IList(Of ArraySegment(Of Byte)), newBaseSeqNum As SequenceNumber, reservationCollection As ReservationCollection, callback As AsyncCallback, state As Object) As IAsyncResultParameters
- 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.
- callback
- AsyncCallback
An optional asynchronous callback, to be called when the restart area write is complete.
- state
- Object
A user-provided object that distinguishes this particular asynchronous restart area write request from other requests.
Returns
An IAsyncResult that represents the asynchronous restart area write operation, which could still be pending.
Implements
Exceptions
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.
One or more of the parameters is null.
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.
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.
The method was called after the sequence has been disposed of.
There is not enough memory to continue the execution of the program.
Access for the specified log sequence is denied by the operating system.
The record sequence is full.
Remarks
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.
Applies to
BeginWriteRestartArea(ArraySegment<Byte>, SequenceNumber, ReservationCollection, AsyncCallback, Object)
Begins an asynchronous restart area write operation, using space previously reserved in the sequence. This method cannot be inherited.
public:
virtual IAsyncResult ^ BeginWriteRestartArea(ArraySegment<System::Byte> data, System::IO::Log::SequenceNumber newBaseSeqNum, System::IO::Log::ReservationCollection ^ reservation, AsyncCallback ^ callback, System::Object ^ state);public IAsyncResult BeginWriteRestartArea (ArraySegment<byte> data, System.IO.Log.SequenceNumber newBaseSeqNum, System.IO.Log.ReservationCollection reservation, AsyncCallback callback, object state);abstract member BeginWriteRestartArea : ArraySegment<byte> * System.IO.Log.SequenceNumber * System.IO.Log.ReservationCollection * AsyncCallback * obj -> IAsyncResult
override this.BeginWriteRestartArea : ArraySegment<byte> * System.IO.Log.SequenceNumber * System.IO.Log.ReservationCollection * AsyncCallback * obj -> IAsyncResultPublic Function BeginWriteRestartArea (data As ArraySegment(Of Byte), newBaseSeqNum As SequenceNumber, reservation As ReservationCollection, callback As AsyncCallback, state As Object) As IAsyncResultParameters
- data
- ArraySegment<Byte>
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.
- reservation
- ReservationCollection
A ReservationCollection that contains the reservation that should be used for this restart area.
- callback
- AsyncCallback
An optional asynchronous callback, to be called when the restart area write is complete.
- state
- Object
A user-provided object that distinguishes this particular asynchronous restart area write request from other requests.
Returns
An IAsyncResult that represents the asynchronous restart area write operation, which could still be pending.
Implements
Exceptions
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-
reservation was not created by this record sequence.
One or more of the parameters is null.
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.
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.
The method was called after the sequence has been disposed of.
There is not enough memory to continue the execution of the program.
Access for the specified log sequence is denied by the operating system.
The record sequence is full.
Remarks
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.
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for