LogRecordSequence.BeginReserveAndAppend Method

Definition

Namespace:

System.IO.Log

Assembly:

System.IO.Log.dll

Begins an asynchronous reserve and append operation.

Overloads

BeginReserveAndAppend(ArraySegment<Byte>, SequenceNumber, SequenceNumber, RecordAppendOptions, ReservationCollection, Int64[], AsyncCallback, Object)	Begins an asynchronous reserve and append operation. This method cannot be inherited.
BeginReserveAndAppend(IList<ArraySegment<Byte>>, SequenceNumber, SequenceNumber, RecordAppendOptions, ReservationCollection, Int64[], AsyncCallback, Object)	Begins an asynchronous reserve and append operation. This method cannot be inherited.

BeginReserveAndAppend(ArraySegment<Byte>, SequenceNumber, SequenceNumber, RecordAppendOptions, ReservationCollection, Int64[], AsyncCallback, Object)

Begins an asynchronous reserve and append operation. This method cannot be inherited.

public:
 virtual IAsyncResult ^ BeginReserveAndAppend(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, AsyncCallback ^ callback, System::Object ^ state);

public IAsyncResult BeginReserveAndAppend (ArraySegment<byte> data, System.IO.Log.SequenceNumber nextUndoRecord, System.IO.Log.SequenceNumber previousRecord, System.IO.Log.RecordAppendOptions recordAppendOptions, System.IO.Log.ReservationCollection reservationCollection, long[] reservations, AsyncCallback callback, object state);

abstract member BeginReserveAndAppend : ArraySegment<byte> * System.IO.Log.SequenceNumber * System.IO.Log.SequenceNumber * System.IO.Log.RecordAppendOptions * System.IO.Log.ReservationCollection * int64[] * AsyncCallback * obj -> IAsyncResult
override this.BeginReserveAndAppend : ArraySegment<byte> * System.IO.Log.SequenceNumber * System.IO.Log.SequenceNumber * System.IO.Log.RecordAppendOptions * System.IO.Log.ReservationCollection * int64[] * AsyncCallback * obj -> IAsyncResult

Public Function BeginReserveAndAppend (data As ArraySegment(Of Byte), nextUndoRecord As SequenceNumber, previousRecord As SequenceNumber, recordAppendOptions As RecordAppendOptions, reservationCollection As ReservationCollection, reservations As Long(), callback As AsyncCallback, state As Object) As IAsyncResult

Parameters

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

The reservation collection to make reservations in.

reservations

Int64[]

The reservations to make, in bytes.

callback

AsyncCallback

An optional asynchronous callback, to be called when the append is complete.

state

Object

A user-provided object that distinguishes this particular asynchronous append request from other requests.

Returns

IAsyncResult

An IAsyncResult that represents this asynchronous operation, which could still be pending.

Implements

BeginReserveAndAppend(ArraySegment<Byte>, SequenceNumber, SequenceNumber, RecordAppendOptions, ReservationCollection, Int64[], AsyncCallback, Object)

Exceptions

ArgumentException

userRecord 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.

ArgumentNullException

One or more of the arguments are null.

ArgumentOutOfRangeException

userRecord or previousRecord 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.

NotSupportedException

The operation cannot be performed because the record sequence was opened with read-only access.

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.

SequenceFullException

The record sequence is full.

UnauthorizedAccessException

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

ReservationNotFoundException

No reservation large enough to fit data can be found in reservations.

Remarks

You should pass the IAsyncResult returned by this method to the EndReserveAndAppend method to ensure that the append operation has completed and resources can be freed appropriately. If an error has occurred during an asynchronous append, an exception is not thrown until the EndReserveAndAppend 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.

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.

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.

BeginReserveAndAppend(IList<ArraySegment<Byte>>, SequenceNumber, SequenceNumber, RecordAppendOptions, ReservationCollection, Int64[], AsyncCallback, Object)

Begins an asynchronous reserve and append operation. This method cannot be inherited.

public:
 virtual IAsyncResult ^ BeginReserveAndAppend(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, AsyncCallback ^ callback, System::Object ^ state);

public IAsyncResult BeginReserveAndAppend (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, long[] reservations, AsyncCallback callback, object state);

abstract member BeginReserveAndAppend : System.Collections.Generic.IList<ArraySegment<byte>> * System.IO.Log.SequenceNumber * System.IO.Log.SequenceNumber * System.IO.Log.RecordAppendOptions * System.IO.Log.ReservationCollection * int64[] * AsyncCallback * obj -> IAsyncResult
override this.BeginReserveAndAppend : System.Collections.Generic.IList<ArraySegment<byte>> * System.IO.Log.SequenceNumber * System.IO.Log.SequenceNumber * System.IO.Log.RecordAppendOptions * System.IO.Log.ReservationCollection * int64[] * AsyncCallback * obj -> IAsyncResult

Public Function BeginReserveAndAppend (data As IList(Of ArraySegment(Of Byte)), userRecord As SequenceNumber, previousRecord As SequenceNumber, recordAppendOptions As RecordAppendOptions, reservationCollection As ReservationCollection, reservations As Long(), callback As AsyncCallback, state As Object) As IAsyncResult

Parameters

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.

callback

AsyncCallback

An optional asynchronous callback, to be called when the append is complete.

state

Object

A user-provided object that distinguishes this particular asynchronous append request from other requests.

Returns

IAsyncResult

An IAsyncResult that represents this asynchronous operation, which could still be pending.

Implements

BeginReserveAndAppend(IList<ArraySegment<Byte>>, SequenceNumber, SequenceNumber, RecordAppendOptions, ReservationCollection, Int64[], AsyncCallback, Object)

Exceptions

ArgumentException

One or more of the arguments is invalid.

IOException

An I/O error occurred while appending the record.

SequenceFullException

The record sequence could not make enough free space to contain the new record, or to make the reservation.

ObjectDisposedException

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

Remarks

You should pass the IAsyncResult returned by this method to the EndReserveAndAppend method to ensure that the append operation has completed and resources can be freed appropriately. If an error has occurred during an asynchronous append, an exception is not thrown until the EndReserveAndAppend 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.

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.

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.