Table of Contents

Interface IRequestClient<TRequest>

Namespace
MassTransit
Assembly
MassTransit.Abstractions.dll

A request client, which is used to send a request, as well as get one or more response types from that request.

public interface IRequestClient<TRequest> where TRequest : class

Type Parameters

TRequest

The request type

Methods

Create(object, CancellationToken, RequestTimeout)

Create a request, returning a RequestHandle<TRequest>, which is then used to get responses, and ultimately send the request.

RequestHandle<TRequest> Create(object values, CancellationToken cancellationToken = default, RequestTimeout timeout = default)

Parameters

values object

The values to initialize the message

cancellationToken CancellationToken

An optional cancellationToken to cancel the request

timeout RequestTimeout

An optional timeout, to automatically cancel the request after the specified timeout period

Returns

RequestHandle<TRequest>

A RequestHandle<TRequest> for the request

Create(TRequest, CancellationToken, RequestTimeout)

Create a request, returning a RequestHandle<TRequest>, which is then used to get responses, and ultimately send the request.

RequestHandle<TRequest> Create(TRequest message, CancellationToken cancellationToken = default, RequestTimeout timeout = default)

Parameters

message TRequest

The request message

cancellationToken CancellationToken

An optional cancellationToken to cancel the request

timeout RequestTimeout

An optional timeout, to automatically cancel the request after the specified timeout period

Returns

RequestHandle<TRequest>

A RequestHandle<TRequest> for the request

GetResponse<T>(object, RequestPipeConfiguratorCallback<TRequest>, CancellationToken, RequestTimeout)

Create a request, and return a task for the specified response type

Task<Response<T>> GetResponse<T>(object values, RequestPipeConfiguratorCallback<TRequest> callback, CancellationToken cancellationToken = default, RequestTimeout timeout = default) where T : class

Parameters

values object

The values to initialize the message

callback RequestPipeConfiguratorCallback<TRequest>
cancellationToken CancellationToken

An optional cancellationToken to cancel the request

timeout RequestTimeout

An optional timeout, to automatically cancel the request after the specified timeout period

Returns

Task<Response<T>>

Type Parameters

T

GetResponse<T>(object, CancellationToken, RequestTimeout)

Create a request, and return a task for the specified response type

Task<Response<T>> GetResponse<T>(object values, CancellationToken cancellationToken = default, RequestTimeout timeout = default) where T : class

Parameters

values object

The values to initialize the message

cancellationToken CancellationToken

An optional cancellationToken to cancel the request

timeout RequestTimeout

An optional timeout, to automatically cancel the request after the specified timeout period

Returns

Task<Response<T>>

Type Parameters

T

GetResponse<T>(TRequest, RequestPipeConfiguratorCallback<TRequest>, CancellationToken, RequestTimeout)

Create a request, and return a task for the specified response type

Task<Response<T>> GetResponse<T>(TRequest message, RequestPipeConfiguratorCallback<TRequest> callback, CancellationToken cancellationToken = default, RequestTimeout timeout = default) where T : class

Parameters

message TRequest

The request message

callback RequestPipeConfiguratorCallback<TRequest>
cancellationToken CancellationToken

An optional cancellationToken to cancel the request

timeout RequestTimeout

An optional timeout, to automatically cancel the request after the specified timeout period

Returns

Task<Response<T>>

Type Parameters

T

GetResponse<T>(TRequest, CancellationToken, RequestTimeout)

Create a request, and return a task for the specified response type

Task<Response<T>> GetResponse<T>(TRequest message, CancellationToken cancellationToken = default, RequestTimeout timeout = default) where T : class

Parameters

message TRequest

The request message

cancellationToken CancellationToken

An optional cancellationToken to cancel the request

timeout RequestTimeout

An optional timeout, to automatically cancel the request after the specified timeout period

Returns

Task<Response<T>>

Type Parameters

T

GetResponse<T1, T2>(object, RequestPipeConfiguratorCallback<TRequest>, CancellationToken, RequestTimeout)

Create a request, and return a task for the specified response types

Task<Response<T1, T2>> GetResponse<T1, T2>(object values, RequestPipeConfiguratorCallback<TRequest> callback, CancellationToken cancellationToken = default, RequestTimeout timeout = default) where T1 : class where T2 : class

Parameters

values object

The values to initialize the message

callback RequestPipeConfiguratorCallback<TRequest>
cancellationToken CancellationToken

An optional cancellationToken to cancel the request

timeout RequestTimeout

An optional timeout, to automatically cancel the request after the specified timeout period

Returns

Task<Response<T1, T2>>

Type Parameters

T1

The first response type

T2

The second response type

GetResponse<T1, T2>(object, CancellationToken, RequestTimeout)

Create a request, and return a task for the specified response types

Task<Response<T1, T2>> GetResponse<T1, T2>(object values, CancellationToken cancellationToken = default, RequestTimeout timeout = default) where T1 : class where T2 : class

Parameters

values object

The values to initialize the message

cancellationToken CancellationToken

An optional cancellationToken to cancel the request

timeout RequestTimeout

An optional timeout, to automatically cancel the request after the specified timeout period

Returns

Task<Response<T1, T2>>

Type Parameters

T1

The first response type

T2

The second response type

GetResponse<T1, T2>(TRequest, RequestPipeConfiguratorCallback<TRequest>, CancellationToken, RequestTimeout)

Create a request, and return a task for the specified response types

Task<Response<T1, T2>> GetResponse<T1, T2>(TRequest message, RequestPipeConfiguratorCallback<TRequest> callback, CancellationToken cancellationToken = default, RequestTimeout timeout = default) where T1 : class where T2 : class

Parameters

message TRequest

The request message

callback RequestPipeConfiguratorCallback<TRequest>
cancellationToken CancellationToken

An optional cancellationToken to cancel the request

timeout RequestTimeout

An optional timeout, to automatically cancel the request after the specified timeout period

Returns

Task<Response<T1, T2>>

Type Parameters

T1

The first response type

T2

The second response type

GetResponse<T1, T2>(TRequest, CancellationToken, RequestTimeout)

Create a request, and return a task for the specified response types

Task<Response<T1, T2>> GetResponse<T1, T2>(TRequest message, CancellationToken cancellationToken = default, RequestTimeout timeout = default) where T1 : class where T2 : class

Parameters

message TRequest

The request message

cancellationToken CancellationToken

An optional cancellationToken to cancel the request

timeout RequestTimeout

An optional timeout, to automatically cancel the request after the specified timeout period

Returns

Task<Response<T1, T2>>

Type Parameters

T1

The first response type

T2

The second response type

GetResponse<T1, T2, T3>(object, RequestPipeConfiguratorCallback<TRequest>, CancellationToken, RequestTimeout)

Create a request, and return a task for the specified response types

Task<Response<T1, T2, T3>> GetResponse<T1, T2, T3>(object values, RequestPipeConfiguratorCallback<TRequest> callback, CancellationToken cancellationToken = default, RequestTimeout timeout = default) where T1 : class where T2 : class where T3 : class

Parameters

values object

The values to initialize the message

callback RequestPipeConfiguratorCallback<TRequest>
cancellationToken CancellationToken

An optional cancellationToken to cancel the request

timeout RequestTimeout

An optional timeout, to automatically cancel the request after the specified timeout period

Returns

Task<Response<T1, T2, T3>>

Type Parameters

T1

The first response type

T2

The second response type

T3

GetResponse<T1, T2, T3>(object, CancellationToken, RequestTimeout)

Create a request, and return a task for the specified response types

Task<Response<T1, T2, T3>> GetResponse<T1, T2, T3>(object values, CancellationToken cancellationToken = default, RequestTimeout timeout = default) where T1 : class where T2 : class where T3 : class

Parameters

values object

The values to initialize the message

cancellationToken CancellationToken

An optional cancellationToken to cancel the request

timeout RequestTimeout

An optional timeout, to automatically cancel the request after the specified timeout period

Returns

Task<Response<T1, T2, T3>>

Type Parameters

T1

The first response type

T2

The second response type

T3

GetResponse<T1, T2, T3>(TRequest, RequestPipeConfiguratorCallback<TRequest>, CancellationToken, RequestTimeout)

Create a request, and return a task for the specified response types

Task<Response<T1, T2, T3>> GetResponse<T1, T2, T3>(TRequest message, RequestPipeConfiguratorCallback<TRequest> callback, CancellationToken cancellationToken = default, RequestTimeout timeout = default) where T1 : class where T2 : class where T3 : class

Parameters

message TRequest

The request message

callback RequestPipeConfiguratorCallback<TRequest>
cancellationToken CancellationToken

An optional cancellationToken to cancel the request

timeout RequestTimeout

An optional timeout, to automatically cancel the request after the specified timeout period

Returns

Task<Response<T1, T2, T3>>

Type Parameters

T1

The first response type

T2

The second response type

T3

GetResponse<T1, T2, T3>(TRequest, CancellationToken, RequestTimeout)

Create a request, and return a task for the specified response types

Task<Response<T1, T2, T3>> GetResponse<T1, T2, T3>(TRequest message, CancellationToken cancellationToken = default, RequestTimeout timeout = default) where T1 : class where T2 : class where T3 : class

Parameters

message TRequest

The request message

cancellationToken CancellationToken

An optional cancellationToken to cancel the request

timeout RequestTimeout

An optional timeout, to automatically cancel the request after the specified timeout period

Returns

Task<Response<T1, T2, T3>>

Type Parameters

T1

The first response type

T2

The second response type

T3