Interface IMessageReceivingOperations<D>
Operations for receiving messages from a destination.
Namespace: Steeltoe.Messaging.Core
Assembly: Steeltoe.Messaging.Abstractions.dll
Syntax
public interface IMessageReceivingOperations<D>Type Parameters
| Name | Description |
|---|---|
| D | the type of the destination |
Methods
| Edit this page View SourceReceive()
Receive a message from a default destination
Declaration
IMessage Receive()Returns
| Type | Description |
|---|---|
| IMessage | the received message; or null |
Receive(D)
Receive a message from the given destination
Declaration
IMessage Receive(D destination)Parameters
| Type | Name | Description |
|---|---|---|
| D | destination | the target destination |
Returns
| Type | Description |
|---|---|
| IMessage | the received message; or null |
ReceiveAndConvert<T>()
Receive a message from a default destination and convert its payload to the specified target type.
Declaration
T ReceiveAndConvert<T>()Returns
| Type | Description |
|---|---|
| T | the received message; or null |
Type Parameters
| Name | Description |
|---|---|
| T | the type of the payload |
ReceiveAndConvert<T>(D)
Receive a message from the given destination and convert its payload to the specified target type.
Declaration
T ReceiveAndConvert<T>(D destination)Parameters
| Type | Name | Description |
|---|---|---|
| D | destination | the target destination |
Returns
| Type | Description |
|---|---|
| T | the received message; or null |
Type Parameters
| Name | Description |
|---|---|
| T | the type of the payload |
ReceiveAndConvertAsync<T>(D, CancellationToken)
Receive a message from the given destination and convert its payload to the specified target type.
Declaration
Task<T> ReceiveAndConvertAsync<T>(D destination, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| D | destination | the target destination |
| CancellationToken | cancellationToken | token used to signal cancelation |
Returns
| Type | Description |
|---|---|
| Task<T> | a task to signal completion |
Type Parameters
| Name | Description |
|---|---|
| T | the type of the payload |
ReceiveAndConvertAsync<T>(CancellationToken)
Receive a message from a default destination and convert its payload to the specified target type.
Declaration
Task<T> ReceiveAndConvertAsync<T>(CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | token used to signal cancelation |
Returns
| Type | Description |
|---|---|
| Task<T> | a task to signal completion |
Type Parameters
| Name | Description |
|---|---|
| T | the type of the payload |
ReceiveAsync(D, CancellationToken)
Receive a message from the given destination
Declaration
Task<IMessage> ReceiveAsync(D destination, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| D | destination | the target destination |
| CancellationToken | cancellationToken | token used to signal cancelation |
Returns
| Type | Description |
|---|---|
| Task<IMessage> | a task to signal completion |
ReceiveAsync(CancellationToken)
Receive a message from a default destination
Declaration
Task<IMessage> ReceiveAsync(CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | token used to signal cancelation |
Returns
| Type | Description |
|---|---|
| Task<IMessage> | a task to signal completion |