ODataBatchWriter Class

Definition

Namespace:

Microsoft.OData

Assembly:

Microsoft.OData.Core.dll

Package:

Microsoft.OData.Core v7.9.0

Abstract class for writing OData batch messages; also verifies the proper sequence of write calls on the writer.

public abstract class ODataBatchWriter

type ODataBatchWriter = class

Public MustInherit Class ODataBatchWriter

Inheritance

Object

ODataBatchWriter

Properties

CurrentOperationRequestMessage	The request message for the operation that is currently written if it's a request; or null if no operation is written right now or it's a response operation.
CurrentOperationResponseMessage	The response message for the operation that is currently written if it's a response; or null if no operation is written right now or it's a request operation.
OutputContext	The output context to write to.

Methods

BuildOperationRequestMessage(Stream, String, Uri, String, String, IEnumerable<String>)	Wrapper method to create an operation request message that can be used to write the operation content to, utilizing private members Microsoft.OData.ODataBatchPayloadUriConverter and IServiceProvider.
BuildOperationResponseMessage(Stream, String, String)	Wrapper method to create an operation response message that can be used to write the operation content to, utilizing private members Microsoft.OData.ODataBatchPayloadUriConverter and IServiceProvider.
CreateOperationRequestMessage(String, Uri, String, BatchPayloadUriOption, IEnumerable<String>)	Creates an ODataBatchOperationRequestMessage for writing an operation of a batch request.
CreateOperationRequestMessage(String, Uri, String, BatchPayloadUriOption)	Creates an ODataBatchOperationRequestMessage for writing an operation of a batch request.
CreateOperationRequestMessage(String, Uri, String)	Creates an ODataBatchOperationRequestMessage for writing an operation of a batch request.
CreateOperationRequestMessageAsync(String, Uri, String, BatchPayloadUriOption, IList<String>)	Creates a message for asynchronously writing an operation of a batch request.
CreateOperationRequestMessageAsync(String, Uri, String, BatchPayloadUriOption)	Creates a message for asynchronously writing an operation of a batch request.
CreateOperationRequestMessageAsync(String, Uri, String)	Creates a message for asynchronously writing an operation of a batch request.
CreateOperationRequestMessageImplementation(String, Uri, String, BatchPayloadUriOption, IEnumerable<String>)	Creates an ODataBatchOperationRequestMessage for writing an operation of a batch request.
CreateOperationResponseMessage(String)	Creates a message for writing an operation of a batch response.
CreateOperationResponseMessageAsync(String)	Asynchronously creates an ODataBatchOperationResponseMessage for writing an operation of a batch response.
CreateOperationResponseMessageImplementation(String)	Creates an ODataBatchOperationResponseMessage for writing an operation of a batch response.
Flush()	Flushes the write buffer to the underlying stream.
FlushAsync()	Flushes the write buffer to the underlying stream asynchronously.
FlushAsynchronously()	Flush the output.
FlushSynchronously()	Flush the output.
GetDependsOnRequestIds(IEnumerable<String>)	Given an enumerable of dependsOn ids containing request ids and group ids, return an enumeration of equivalent request ids.
OnInStreamError()	This method notifies the listener, that an in-stream error is to be written.
OnInStreamErrorAsync()	System.Object.OnInStreamErrorAsync
SetState(ODataBatchWriter+BatchWriterState)	Sets a new writer state; verifies that the transition from the current state into new state is valid.
StreamDisposed()	This method is called to notify that the content stream of a batch operation has been disposed.
StreamDisposedAsync()	This method is called asynchronously to notify that the content stream of a batch operation has been disposed.
StreamRequested()	This method is called to notify that the content stream for a batch operation has been requested.
StreamRequestedAsync()	This method is called to notify that the content stream for a batch operation has been requested.
ValidateDependsOnIds(String, IEnumerable<String>)	Validate the dependsOnIds.
VerifyNotDisposed()	Verifies that the writer is not disposed.
WriteEndBatch()	Ends a batch; can only be called after WriteStartBatch has been called and if no other active changeset or operation exist.
WriteEndBatchAsync()	Asynchronously ends a batch; can only be called after WriteStartBatch has been called and if no other active change set or operation exist.
WriteEndBatchImplementation()	Ends a batch.
WriteEndChangeset()	Ends an active changeset; this can only be called after WriteStartChangeset and only once for each changeset.
WriteEndChangesetAsync()	Asynchronously ends an active change set; this can only be called after WriteStartChangeset and only once for each change set.
WriteEndChangesetImplementation()	Ends an active changeset.
WriteStartBatch()	Starts a new batch; can be only called once and as first call.
WriteStartBatchAsync()	Asynchronously starts a new batch; can be only called once and as first call.
WriteStartBatchImplementation()	Starts a new batch.
WriteStartChangeset()	Starts a new changeset without specifying group id. This can only be called after WriteStartBatch and if no other active operation or changeset exists.
WriteStartChangeset(String)	Starts a new atomic group or changeset with the specified group id or changeset GUID corresponding to change set boundary. This can only be called after WriteStartBatch and if no other active operation or changeset exists.
WriteStartChangesetAsync()	Asynchronously starts a new change set without specifying group id; This can only be called after WriteStartBatch and if no other active operation or change set exists.
WriteStartChangesetAsync(String)	Asynchronously starts a new change set; can only be called after WriteStartBatch and if no other active operation or change set exists.
WriteStartChangesetImplementation(String)	Starts a new changeset.