FileRecordSequence.BeginAppend Method

Definition

Begins an asynchronous append operation.

Overloads

BeginAppend(IList<ArraySegment<Byte>>, SequenceNumber, SequenceNumber, RecordAppendOptions, ReservationCollection, AsyncCallback, Object)

Begins an asynchronous append operation using space previously reserved in the sequence. This method cannot be inherited.

BeginAppend(ArraySegment<Byte>, SequenceNumber, SequenceNumber, RecordAppendOptions, ReservationCollection, AsyncCallback, Object)

Begins an asynchronous append operation using space previously reserved in the sequence. This method cannot be inherited.

BeginAppend(ArraySegment<Byte>, SequenceNumber, SequenceNumber, RecordAppendOptions, AsyncCallback, Object)

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

BeginAppend(IList<ArraySegment<Byte>>, SequenceNumber, SequenceNumber, RecordAppendOptions, AsyncCallback, Object)

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

BeginAppend(IList<ArraySegment<Byte>>, SequenceNumber, SequenceNumber, RecordAppendOptions, ReservationCollection, AsyncCallback, Object)

Begins an asynchronous append operation using space previously reserved in the sequence. This method cannot be inherited.

public:
 virtual IAsyncResult ^ BeginAppend(System::Collections::Generic::IList<ArraySegment<System::Byte>> ^ data, System::IO::Log::SequenceNumber nextUndoRecord, System::IO::Log::SequenceNumber previousRecord, System::IO::Log::RecordAppendOptions recordAppendOptions, System::IO::Log::ReservationCollection ^ reservations, AsyncCallback ^ callback, System::Object ^ state);
public IAsyncResult BeginAppend (System.Collections.Generic.IList<ArraySegment<byte>> data, System.IO.Log.SequenceNumber nextUndoRecord, System.IO.Log.SequenceNumber previousRecord, System.IO.Log.RecordAppendOptions recordAppendOptions, System.IO.Log.ReservationCollection reservations, AsyncCallback callback, object state);
abstract member BeginAppend : System.Collections.Generic.IList<ArraySegment<byte>> * System.IO.Log.SequenceNumber * System.IO.Log.SequenceNumber * System.IO.Log.RecordAppendOptions * System.IO.Log.ReservationCollection * AsyncCallback * obj -> IAsyncResult
override this.BeginAppend : System.Collections.Generic.IList<ArraySegment<byte>> * System.IO.Log.SequenceNumber * System.IO.Log.SequenceNumber * System.IO.Log.RecordAppendOptions * System.IO.Log.ReservationCollection * AsyncCallback * obj -> IAsyncResult
Public Function BeginAppend (data As IList(Of ArraySegment(Of Byte)), nextUndoRecord As SequenceNumber, previousRecord As SequenceNumber, recordAppendOptions As RecordAppendOptions, reservations As ReservationCollection, 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.

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.

reservations
ReservationCollection

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

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 the asynchronous append, which could still be pending.

Implements

Exceptions

One or more of the arguments are null.

One or more of the arguments are out of range.

reservations was not created by this record sequence.

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

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

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.

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

Remarks

You should pass the IAsyncResult returned by this method to the EndAppend 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 EndAppend 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 appended record will consume space that has been previously reserved, using a reservation specified by the reservations parameter. If the append succeeds, it will consume the smallest reservation area that can hold the data, and that reservation area will be removed from the collection.

Normally, this method completes 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.

BeginAppend(ArraySegment<Byte>, SequenceNumber, SequenceNumber, RecordAppendOptions, ReservationCollection, AsyncCallback, Object)

Begins an asynchronous append operation using space previously reserved in the sequence. This method cannot be inherited.

public:
 virtual IAsyncResult ^ BeginAppend(ArraySegment<System::Byte> data, System::IO::Log::SequenceNumber nextUndoRecord, System::IO::Log::SequenceNumber previousRecord, System::IO::Log::RecordAppendOptions recordAppendOptions, System::IO::Log::ReservationCollection ^ reservations, AsyncCallback ^ callback, System::Object ^ state);
public IAsyncResult BeginAppend (ArraySegment<byte> data, System.IO.Log.SequenceNumber nextUndoRecord, System.IO.Log.SequenceNumber previousRecord, System.IO.Log.RecordAppendOptions recordAppendOptions, System.IO.Log.ReservationCollection reservations, AsyncCallback callback, object state);
abstract member BeginAppend : ArraySegment<byte> * System.IO.Log.SequenceNumber * System.IO.Log.SequenceNumber * System.IO.Log.RecordAppendOptions * System.IO.Log.ReservationCollection * AsyncCallback * obj -> IAsyncResult
override this.BeginAppend : ArraySegment<byte> * System.IO.Log.SequenceNumber * System.IO.Log.SequenceNumber * System.IO.Log.RecordAppendOptions * System.IO.Log.ReservationCollection * AsyncCallback * obj -> IAsyncResult
Public Function BeginAppend (data As ArraySegment(Of Byte), nextUndoRecord As SequenceNumber, previousRecord As SequenceNumber, recordAppendOptions As RecordAppendOptions, reservations As ReservationCollection, 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.

reservations
ReservationCollection

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

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 the asynchronous append, which could still be pending.

Implements

Exceptions

One or more of the arguments are null.

One or more of the arguments are out of range.

reservations was not created by this record sequence.

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

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

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.

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

Remarks

You should pass the IAsyncResult returned by this method to the EndAppend 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 EndAppend 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 appended record will consume space that has been previously reserved, using a reservation specified by the reservations parameter. If the append succeeds, it will consume the smallest reservation area that can hold the data, and that reservation area will be removed from the collection.

Normally, this method completes 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.

BeginAppend(ArraySegment<Byte>, SequenceNumber, SequenceNumber, RecordAppendOptions, AsyncCallback, Object)

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

public:
 virtual IAsyncResult ^ BeginAppend(ArraySegment<System::Byte> data, System::IO::Log::SequenceNumber nextUndoRecord, System::IO::Log::SequenceNumber previousRecord, System::IO::Log::RecordAppendOptions recordAppendOptions, AsyncCallback ^ callback, System::Object ^ state);
public IAsyncResult BeginAppend (ArraySegment<byte> data, System.IO.Log.SequenceNumber nextUndoRecord, System.IO.Log.SequenceNumber previousRecord, System.IO.Log.RecordAppendOptions recordAppendOptions, AsyncCallback callback, object state);
abstract member BeginAppend : ArraySegment<byte> * System.IO.Log.SequenceNumber * System.IO.Log.SequenceNumber * System.IO.Log.RecordAppendOptions * AsyncCallback * obj -> IAsyncResult
override this.BeginAppend : ArraySegment<byte> * System.IO.Log.SequenceNumber * System.IO.Log.SequenceNumber * System.IO.Log.RecordAppendOptions * AsyncCallback * obj -> IAsyncResult
Public Function BeginAppend (data As ArraySegment(Of Byte), nextUndoRecord As SequenceNumber, previousRecord As SequenceNumber, recordAppendOptions As RecordAppendOptions, 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.

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 the asynchronous append, which could still be pending.

Implements

Exceptions

One or more of the arguments are null.

One or more of the arguments are out of range.

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

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

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.

Remarks

You should pass the IAsyncResult returned by this method to the EndAppend 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 EndAppend 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.

Normally, this method completes 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.

BeginAppend(IList<ArraySegment<Byte>>, SequenceNumber, SequenceNumber, RecordAppendOptions, AsyncCallback, Object)

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

public:
 virtual IAsyncResult ^ BeginAppend(System::Collections::Generic::IList<ArraySegment<System::Byte>> ^ data, System::IO::Log::SequenceNumber nextUndoRecord, System::IO::Log::SequenceNumber previousRecord, System::IO::Log::RecordAppendOptions recordAppendOptions, AsyncCallback ^ callback, System::Object ^ state);
public IAsyncResult BeginAppend (System.Collections.Generic.IList<ArraySegment<byte>> data, System.IO.Log.SequenceNumber nextUndoRecord, System.IO.Log.SequenceNumber previousRecord, System.IO.Log.RecordAppendOptions recordAppendOptions, AsyncCallback callback, object state);
abstract member BeginAppend : System.Collections.Generic.IList<ArraySegment<byte>> * System.IO.Log.SequenceNumber * System.IO.Log.SequenceNumber * System.IO.Log.RecordAppendOptions * AsyncCallback * obj -> IAsyncResult
override this.BeginAppend : System.Collections.Generic.IList<ArraySegment<byte>> * System.IO.Log.SequenceNumber * System.IO.Log.SequenceNumber * System.IO.Log.RecordAppendOptions * AsyncCallback * obj -> IAsyncResult
Public Function BeginAppend (data As IList(Of ArraySegment(Of Byte)), nextUndoRecord As SequenceNumber, previousRecord As SequenceNumber, recordAppendOptions As RecordAppendOptions, 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.

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.

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 the asynchronous append, which could still be pending.

Implements

Exceptions

One or more of the arguments are null.

One or more of the arguments are out of range.

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

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

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.

Remarks

You should pass the IAsyncResult returned by this method to the EndAppend 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 EndAppend 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.

Normally, this method completes 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