Class NewtonsoftJsonMessageSerializerBase
The base class for NewtonsoftJsonMessageSerializer and NewtonsoftJsonMessageSerializer<TMessage>.
Inheritance
Implements
Inherited Members
Namespace: Silverback.Messaging.Serialization
Assembly: Silverback.Integration.Newtonsoft.dll
Syntax
public abstract class NewtonsoftJsonMessageSerializerBase : IMessageSerializer
Properties
| Improve this doc View sourceEncoding
Gets or sets the message encoding. The default is UTF8.
Declaration
public MessageEncoding Encoding { get; set; }
Property Value
Type | Description |
---|---|
MessageEncoding |
RequireHeaders
Gets a value indicating whether headers are mandatory for this serializer implementation or configuration to work properly.
Declaration
public abstract bool RequireHeaders { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Settings
Gets or sets the settings to be applied to the Json.NET serializer.
Declaration
public JsonSerializerSettings Settings { get; set; }
Property Value
Type | Description |
---|---|
Newtonsoft.Json.JsonSerializerSettings |
SystemEncoding
Gets the System.Text.Encoding corresponding to the MessageEncoding.
Declaration
protected Encoding SystemEncoding { get; }
Property Value
Type | Description |
---|---|
System.Text.Encoding | A System.Text.Encoding that matches the current MessageEncoding. |
Methods
| Improve this doc View sourceDeserializeAsync(Stream, MessageHeaderCollection, MessageSerializationContext)
Deserializes the byte array back into a message object.
Declaration
public abstract ValueTask<(object Message, Type MessageType)> DeserializeAsync(Stream messageStream, MessageHeaderCollection messageHeaders, MessageSerializationContext context)
Parameters
Type | Name | Description |
---|---|---|
System.IO.Stream | messageStream | The System.IO.Stream containing the message to be deserialized. |
MessageHeaderCollection | messageHeaders | The message headers collection. |
MessageSerializationContext | context | The context information. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.ValueTask<System.ValueTuple<System.Object, System.Type>> | A System.Threading.Tasks.Task<TResult> representing the asynchronous operation. The task result contains the
deserialized message (or |
SerializeAsync(Object, MessageHeaderCollection, MessageSerializationContext)
Serializes the specified message object into a byte array.
Declaration
public abstract ValueTask<Stream> SerializeAsync(object message, MessageHeaderCollection messageHeaders, MessageSerializationContext context)
Parameters
Type | Name | Description |
---|---|---|
System.Object | message | The message object to be serialized. |
MessageHeaderCollection | messageHeaders | The message headers collection. |
MessageSerializationContext | context | The context information. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.ValueTask<System.IO.Stream> | A System.Threading.Tasks.Task<TResult> representing the asynchronous operation. The task result contains the System.IO.Stream with the serialized message. |