Class IncomingRequest

Namespace

IceRpc

Assembly

IceRpc.dll

Represents a request frame received by the application.

public sealed class IncomingRequest : IncomingFrame, IDisposable

Inheritance

object

IncomingFrame

IncomingRequest

Implements

IDisposable

Inherited Members

IncomingFrame.ConnectionContext

IncomingFrame.Payload

IncomingFrame.Protocol

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

IncomingFrameExtensions.DetachPayload(IncomingFrame)

IncomingRequestExtensions.DispatchBidiStreamingAsync<TInput, TOutput, TService>(IncomingRequest, MessageParser<TInput>, TService, Func<TService, IAsyncEnumerable<TInput>, IFeatureCollection, CancellationToken, ValueTask<IAsyncEnumerable<TOutput>>>, CancellationToken)

IncomingRequestExtensions.DispatchClientStreamingAsync<TInput, TOutput, TService>(IncomingRequest, MessageParser<TInput>, TService, Func<TService, IAsyncEnumerable<TInput>, IFeatureCollection, CancellationToken, ValueTask<TOutput>>, CancellationToken)

IncomingRequestExtensions.DispatchServerStreamingAsync<TInput, TOutput, TService>(IncomingRequest, MessageParser<TInput>, TService, Func<TService, TInput, IFeatureCollection, CancellationToken, ValueTask<IAsyncEnumerable<TOutput>>>, CancellationToken)

IncomingRequestExtensions.DispatchUnaryAsync<TInput, TOutput, TService>(IncomingRequest, MessageParser<TInput>, TService, Func<TService, TInput, IFeatureCollection, CancellationToken, ValueTask<TOutput>>, CancellationToken)

IncomingRequestExtensions.CheckNonIdempotent(IncomingRequest)

IncomingRequestExtensions.CreateSliceExceptionResponse(IncomingRequest, SliceException, SliceEncoding)

IncomingRequestExtensions.DecodeArgsAsync<T>(IncomingRequest, SliceEncoding, DecodeFunc<T>, IActivator?, CancellationToken)

IncomingRequestExtensions.DecodeEmptyArgsAsync(IncomingRequest, SliceEncoding, CancellationToken)

Constructors

IncomingRequest(Protocol, IConnectionContext)

Constructs an incoming request.

public IncomingRequest(Protocol protocol, IConnectionContext connectionContext)

Parameters

protocol Protocol

The protocol of this request.

connectionContext IConnectionContext

The connection context of the connection that received this request.

Properties

Features

Gets or sets the features of this request.

public IFeatureCollection Features { get; set; }

Property Value

IFeatureCollection

The IFeatureCollection of this request. Defaults to Empty.

Fields

Gets or sets the fields of this request.

public IDictionary<RequestFieldKey, ReadOnlySequence<byte>> Fields { get; set; }

Property Value

IDictionary<RequestFieldKey, ReadOnlySequence<byte>>

The fields of this request. Defaults to Empty.

Fragment

Gets or initializes the fragment of the target service.

public string Fragment { get; init; }

Property Value

string

The fragment of the target service. It is always the empty string with the icerpc protocol. Defaults to the empty string.

IsOneway

Gets a value indicating whether this request is one-way or two-way.

public bool IsOneway { get; init; }

Property Value

bool

true for one-way requests; otherwise, false. The default is false.

Operation

Gets or initializes the name of the operation to call on the target service.

public string Operation { get; init; }

Property Value

string

The name of the operation. Defaults to the empty string.

Path

Gets or initializes the path of the target service.

public string Path { get; init; }

Property Value

string

The path of the target service. Defaults to /.

Methods

Dispose()

Disposes this incoming request. This completes the payload of this request and the payload(s) of the response associated with this request (if set).

public void Dispose()

ToString()

Returns a string that represents this incoming request.

public override string ToString()

Returns

string

A string that represents this incoming requests.