LogRecordSequence.ReserveAndAppend 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.
Automatically makes a single reservation and appends a record to the sequence.
Overloads
| ReserveAndAppend(IList<ArraySegment<Byte>>, SequenceNumber, SequenceNumber, RecordAppendOptions, ReservationCollection, Int64[]) |
Automatically makes a single reservation and appends a record to the sequence. This method cannot be inherited. |
| ReserveAndAppend(ArraySegment<Byte>, SequenceNumber, SequenceNumber, RecordAppendOptions, ReservationCollection, Int64[]) |
Automatically makes a single reservation and appends a record to the sequence. This method cannot be inherited. |
ReserveAndAppend(IList<ArraySegment<Byte>>, SequenceNumber, SequenceNumber, RecordAppendOptions, ReservationCollection, Int64[])
Automatically makes a single reservation and appends a record to the sequence. This method cannot be inherited.
public:
virtual System::IO::Log::SequenceNumber ReserveAndAppend(System::Collections::Generic::IList<ArraySegment<System::Byte>> ^ data, System::IO::Log::SequenceNumber userRecord, System::IO::Log::SequenceNumber previousRecord, System::IO::Log::RecordAppendOptions recordAppendOptions, System::IO::Log::ReservationCollection ^ reservationCollection, ... cli::array <long> ^ reservations);public System.IO.Log.SequenceNumber ReserveAndAppend (System.Collections.Generic.IList<ArraySegment<byte>> data, System.IO.Log.SequenceNumber userRecord, System.IO.Log.SequenceNumber previousRecord, System.IO.Log.RecordAppendOptions recordAppendOptions, System.IO.Log.ReservationCollection reservationCollection, params long[] reservations);abstract member ReserveAndAppend : System.Collections.Generic.IList<ArraySegment<byte>> * System.IO.Log.SequenceNumber * System.IO.Log.SequenceNumber * System.IO.Log.RecordAppendOptions * System.IO.Log.ReservationCollection * int64[] -> System.IO.Log.SequenceNumber
override this.ReserveAndAppend : System.Collections.Generic.IList<ArraySegment<byte>> * System.IO.Log.SequenceNumber * System.IO.Log.SequenceNumber * System.IO.Log.RecordAppendOptions * System.IO.Log.ReservationCollection * int64[] -> System.IO.Log.SequenceNumberPublic Function ReserveAndAppend (data As IList(Of ArraySegment(Of Byte)), userRecord As SequenceNumber, previousRecord As SequenceNumber, recordAppendOptions As RecordAppendOptions, reservationCollection As ReservationCollection, ParamArray reservations As Long()) As SequenceNumberParameters
- data
- IList<ArraySegment<Byte>>
A list of byte array segments that will be concatenated and appended as the record.
- userRecord
- SequenceNumber
The sequence number of the next record in the user-specified order.
- previousRecord
- SequenceNumber
The sequence number of the next record in Previous order.
- recordAppendOptions
- RecordAppendOptions
A valid value of RecordAppendOptions that specifies how the data should be written.
- reservationCollection
- ReservationCollection
The reservation collection to make reservations in.
- reservations
- Int64[]
The reservations to make, in bytes.
Returns
The sequence number of the appended log record.
Implements
Exceptions
One or more of the arguments is invalid.
An I/O error occurred while appending the record.
The record sequence could not make enough free space to contain the new record, or to make the reservation.
The method was called after the sequence has been disposed of.
One or more of the arguments are null.
userRecord or previousRecord is not between the base and last sequence numbers of this sequence.
The operation cannot be performed because the record sequence was opened with read-only access.
There is not enough memory to continue the execution of the program.
Access for the specified log sequence is denied by the operating system.
No reservation large enough to fit data can be found in reservations.
Remarks
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.
The specified reservations are added to the provided reservation collection in an atomic operation with a record append operation. If the append fails, no space is reserved.
Normally, this method may complete before the record has been written. To ensure that a record has been written, either specify the ForceFlush flag using the recordAppendOptions parameter, or call the Flush method.
Applies to
ReserveAndAppend(ArraySegment<Byte>, SequenceNumber, SequenceNumber, RecordAppendOptions, ReservationCollection, Int64[])
Automatically makes a single reservation and appends a record to the sequence. This method cannot be inherited.
public:
virtual System::IO::Log::SequenceNumber ReserveAndAppend(ArraySegment<System::Byte> data, System::IO::Log::SequenceNumber nextUndoRecord, System::IO::Log::SequenceNumber previousRecord, System::IO::Log::RecordAppendOptions recordAppendOptions, System::IO::Log::ReservationCollection ^ reservationCollection, ... cli::array <long> ^ reservations);public System.IO.Log.SequenceNumber ReserveAndAppend (ArraySegment<byte> data, System.IO.Log.SequenceNumber nextUndoRecord, System.IO.Log.SequenceNumber previousRecord, System.IO.Log.RecordAppendOptions recordAppendOptions, System.IO.Log.ReservationCollection reservationCollection, params long[] reservations);abstract member ReserveAndAppend : ArraySegment<byte> * System.IO.Log.SequenceNumber * System.IO.Log.SequenceNumber * System.IO.Log.RecordAppendOptions * System.IO.Log.ReservationCollection * int64[] -> System.IO.Log.SequenceNumber
override this.ReserveAndAppend : ArraySegment<byte> * System.IO.Log.SequenceNumber * System.IO.Log.SequenceNumber * System.IO.Log.RecordAppendOptions * System.IO.Log.ReservationCollection * int64[] -> System.IO.Log.SequenceNumberPublic Function ReserveAndAppend (data As ArraySegment(Of Byte), nextUndoRecord As SequenceNumber, previousRecord As SequenceNumber, recordAppendOptions As RecordAppendOptions, reservationCollection As ReservationCollection, ParamArray reservations As Long()) As SequenceNumberParameters
- data
- ArraySegment<Byte>
A list of byte array segments that will be concatenated and appended as the record.
- nextUndoRecord
- SequenceNumber
The sequence number of the next record in the user-specified order.
- previousRecord
- SequenceNumber
The sequence number of the next record in Previous order.
- recordAppendOptions
- RecordAppendOptions
A valid value of RecordAppendOptions that specifies how the data should be written.
- reservationCollection
- ReservationCollection
A ReservationCollection that contains the collection to make reservations in.
- reservations
- Int64[]
The reservations to make, in bytes.
Returns
The sequence number of the appended log record.
Implements
Exceptions
nextUndoRecord or previousRecord is not valid for this sequence.
-or-
data cannot be appended because it is larger than the maximum record size.
-or-
reservations was not created by this record sequence.
One or more of the arguments are null.
nextUndoRecord or previousRecord 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 operation cannot be performed because the record sequence was opened with read-only access.
The method was called after the sequence has been disposed of.
There is not enough memory to continue the execution of the program.
The record sequence is full.
Access for the specified log sequence is denied by the operating system.
No reservation large enough to fit data can be found in reservations.
Examples
The following example shows how to use this method to make reservations. Notice that this task can only be performed when using the CLFS-based LogRecordSequence class.
ReservationCollection reservations = recordSequence.CreateReservationCollection();
long[] lengthOfUndoRecords = new long[] { 1000 };
recordSequence.ReserveAndAppend(recordData,
userSqn,
previousSqn,
RecordSequenceAppendOptions.None,
reservations,
lengthOfUndoRecords);
recordSequence.Append(undoRecordData, // If necessary …
userSqn,
previousSqn,
RecordSequenceAppendOptions.ForceFlush,
reservations);
Remarks
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.
The specified reservations are added to the provided reservation collection in an atomic operation with a record append operation. If the append fails, no space is reserved.
Normally, this method may complete before the record has been written. To ensure that a record has been written, either specify the ForceFlush flag using the recordAppendOptions parameter, or call the Flush method.
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