Interface IBrokeredMessage
Contract interface for brokered messages.
Inherited Members
Namespace: Kephas.Messaging.Distributed
Assembly: Kephas.Messaging.dll
Syntax
public interface IBrokeredMessage : IIdentifiable, IMessageEnvelope, IMessage
Properties
| Improve this Doc View SourceBearerToken
Gets the bearer token.
Declaration
string BearerToken { get; }
Property Value
Type | Description |
---|---|
System.String | The bearer token. |
Channel
Gets the channel.
Declaration
string Channel { get; }
Property Value
Type | Description |
---|---|
System.String | The channel. |
Content
Gets the message to send.
Declaration
IMessage Content { get; }
Property Value
Type | Description |
---|---|
IMessage | The message. |
Id
Gets the identifier.
Declaration
string Id { get; }
Property Value
Type | Description |
---|---|
System.String | The identifier. |
IsOneWay
Gets a value indicating whether this message is one way.
Declaration
bool IsOneWay { get; }
Property Value
Type | Description |
---|---|
System.Boolean | True if this message is one way, false if not. |
Recipients
Gets the recipients.
Declaration
IEnumerable<IEndpoint> Recipients { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<IEndpoint> | The recipients. |
ReplyToMessageId
Gets the identifier of the message to reply to.
Declaration
string ReplyToMessageId { get; }
Property Value
Type | Description |
---|---|
System.String | The identifier of the reply to message. |
Sender
Gets the sender of the message.
Declaration
IEndpoint Sender { get; }
Property Value
Type | Description |
---|---|
IEndpoint | The message sender. |
Timeout
Gets the timeout when waiting for responses.
Declaration
TimeSpan? Timeout { get; }
Property Value
Type | Description |
---|---|
System.Nullable<System.TimeSpan> | The response timeout. |
Remarks
A value of null
means indefinitely waiting, but
it is strongly discouraged to wait indefinitely for a response.
The default value DefaultTimeout can be used.
Methods
| Improve this Doc View SourceClone(IEnumerable<IEndpoint>)
Makes a deep copy of this object, optionally replacing the existing recipients with the provided ones.
Declaration
IBrokeredMessage Clone(IEnumerable<IEndpoint> recipients = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<IEndpoint> | recipients | Optional. The recipients. |
Returns
Type | Description |
---|---|
IBrokeredMessage | A copy of this object. |