ProtocolDefinitionMessage (3.14.0 400 API)
Date: 2018-11-22

com.marketfactory.messaging

## Class ProtocolDefinitionMessage

- java.lang.Object
- - com.marketfactory.messaging.ProtocolDefinitionMessage

- All Implemented Interfaces:
    IMessage, java.io.Serializable, java.lang.Comparable<ProtocolDefinitionMessage>

      public final class ProtocolDefinitionMessage
      extends java.lang.Object
      implements IMessage, java.lang.Comparable<ProtocolDefinitionMessage>, java.io.Serializable

  This is a special message that contains the protocol definition itself (this file). Because the binary protocol is not self- describing (designed that way to be compact), one needs a description of the protocol in order to parse a binary log file. It is included as a message at the head of every binary log file as a last-resort source of protocol format, which could allow us to generate a parser for the rest of the protocol based on this description, for very old log files. (Hopefully we nevrer have to use this.)
  See Also:
    Serialized Form

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static int` | `ID`
    `java.lang.String` | `proto`

  - ### Constructor Summary

    Constructors
    Modifier | Constructor and Description
    --- | ---
    `` | `ProtocolDefinitionMessage()`
    `protected` | `ProtocolDefinitionMessage(ProtoByteBuffer buffer)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `int` | `compareTo(ProtocolDefinitionMessage rhs)`
    `void` | `deserialize(ProtoByteBuffer buffer)`
    `protected void` | `dump(TextWriter wr)`
    `boolean` | `equals(java.lang.Object rhs)`
    `int` | `getMsgType()`
    `int` | `hashCode()`
    `void` | `serialize(ProtoByteBuffer buffer)`
    `java.lang.String` | `toString()`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### Field Detail

    - #### proto

          public java.lang.String proto

    - #### ID

          public static final int ID

      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### ProtocolDefinitionMessage

          public ProtocolDefinitionMessage()

    - #### ProtocolDefinitionMessage

          protected ProtocolDefinitionMessage(ProtoByteBuffer buffer)

  - ### Method Detail

    - #### getMsgType

          public int getMsgType()

      Specified by:
        `getMsgType` in interface `IMessage`

    - #### equals

          public boolean equals(java.lang.Object rhs)

      Overrides:
        `equals` in class `java.lang.Object`

    - #### compareTo

          public int compareTo(ProtocolDefinitionMessage rhs)

      Specified by:
        `compareTo` in interface `java.lang.Comparable<ProtocolDefinitionMessage>`

    - #### hashCode

          public int hashCode()

      Overrides:
        `hashCode` in class `java.lang.Object`

    - #### deserialize

          public void deserialize(ProtoByteBuffer buffer)

      Specified by:
        `deserialize` in interface `IMessage`

    - #### serialize

          public void serialize(ProtoByteBuffer buffer)

      Specified by:
        `serialize` in interface `IMessage`

    - #### toString

          public java.lang.String toString()

      Specified by:
        `toString` in interface `IMessage`
      Overrides:
        `toString` in class `java.lang.Object`

    - #### dump

          protected void dump(TextWriter wr)