Class Message


  • public class Message
    extends Object
    Class to define Message. Messages are composed of a "type" and a body. Some examples of message types are : COMM_FAILURE, SRV_QUEUE, MSG_LOGIN, TEST_PREPARE. Messages are defined to have a "length" field too. Currently, 2 bytes of the message "body" byte array are often used to store length (For example, second/third array positions)

    TODO for a later release: It may be worthwhile exploring whether MessageTypes could be merged here instead of being located in NDTConstants. Message/Type could also be made into an enumeration and checks for the current MessageType being assigned could be incorporated.

    See Also:
    for more Message Types.
    • Field Detail

      • _yType

        byte _yType
      • _yaBody

        byte[] _yaBody
    • Constructor Detail

      • Message

        public Message()
    • Method Detail

      • getType

        public byte getType()
        Get Message Type
        Returns:
        byte indicating Message Type
      • setType

        public void setType​(byte bParamType)
        Set Message Type
        Parameters:
        bParamType - byte indicating Message Type
      • getBody

        public byte[] getBody()
        Get Message body as array
        Returns:
        byte array message body
      • setBody

        public void setBody​(byte[] baParamBody)
        Set Message body, given a byte array input
        Parameters:
        baParamBody - message body byte array
      • setBody

        public void setBody​(byte[] baParamBody,
                            int iParamSize)
        Set Message body, given a byte array and a size parameter. This may be useful if user wants to initialize the message, and then continue to populate it later. This method is unused currently.
        Parameters:
        iParamSize - byte array size
        baParamBody - message body byte array
      • initBodySize

        public void initBodySize​(int iParamSize)
        Utility method to initialize Message body
        Parameters:
        iParamSize - byte array size