Struct B3MessageHeader
B3 message header.
Inherited Members
Namespace: OnixS.SimpleBinaryEncoding
Assembly: OnixS.SimpleBinaryEncoding.dll
Syntax
[EncodingTypeForEncoder(60240)]
public struct B3MessageHeader : IMessageHeaderWithEncodingType, IMessageHeader, IEquatable<B3MessageHeader>Properties
BlockLength
Declaration
public ushort BlockLength { readonly get; set; }Property Value
| Type | Description |
|---|---|
| ushort | Size of the message root block. |
EncodingType
Declaration
public ushort EncodingType { readonly get; set; }Property Value
| Type | Description |
|---|---|
| ushort | The identifier of the encoding used in the message payload. |
MessageLength
Declaration
public ushort MessageLength { readonly get; set; }Property Value
| Type | Description |
|---|---|
| ushort | The overall message size, including this message header. |
SchemaID
Declaration
public ushort SchemaID { readonly get; set; }Property Value
| Type | Description |
|---|---|
| ushort | SBE Schema identifier. |
TemplateID
Declaration
public ushort TemplateID { readonly get; set; }Property Value
| Type | Description |
|---|---|
| ushort | Message Template identifier. |
Version
Declaration
public ushort Version { readonly get; set; }Property Value
| Type | Description |
|---|---|
| ushort | SBE Schema version. |
Methods
Equals(B3MessageHeader)
Indicates whether the current object is equal to another object of the same type.
Declaration
public readonly bool Equals(B3MessageHeader other)Parameters
| Type | Name | Description |
|---|---|---|
| B3MessageHeader | other | An object to compare with this object |
Returns
| Type | Description |
|---|---|
| bool | true if the current object is equal to the other parameter; otherwise, false |
Equals(object)
Indicates whether the current object is equal to another object of the same type.
Declaration
public override readonly bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| object | obj | An object to compare with this object |
Returns
| Type | Description |
|---|---|
| bool | true if the current object is equal to the other parameter; otherwise, false |
Overrides
GetHashCode()
Serves as the default hash function.
Declaration
public override readonly int GetHashCode()Returns
| Type | Description |
|---|---|
| int | A hash code for the current object |
Overrides
Operators
operator ==(B3MessageHeader, B3MessageHeader)
Declaration
public static bool operator ==(B3MessageHeader left, B3MessageHeader right)Parameters
| Type | Name | Description |
|---|---|---|
| B3MessageHeader | left | |
| B3MessageHeader | right |
Returns
| Type | Description |
|---|---|
| bool |
operator !=(B3MessageHeader, B3MessageHeader)
Declaration
public static bool operator !=(B3MessageHeader left, B3MessageHeader right)Parameters
| Type | Name | Description |
|---|---|---|
| B3MessageHeader | left | |
| B3MessageHeader | right |
Returns
| Type | Description |
|---|---|
| bool |