Package org.jgroups.blocks

Class RequestCorrelator.Header

    • Field Summary

      Fields 
      Modifier and Type Field Description
      short corrId
      The unique ID of the associated RequestCorrelator
      static byte EXC_RSP  
      static byte REQ  
      long req_id
      The request id (unique for each blocking request), 0 means no response is expected
      static byte RSP  
      byte type
      Type of header: request or reply

    • Constructor Summary

      Constructors 
      Constructor Description
      Header()  
      Header​(byte type, long req_id, short corr_id)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      short corrId()  
      java.util.function.Supplier<? extends Header> create()
      Creates an instance of the class implementing this interface
      short getMagicId()
      Returns the magic-ID.
      void readFrom​(java.io.DataInput in)
      Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed
      long requestId()  
      RequestCorrelator.Header requestId​(long req_id)  
      boolean rspExpected()  
      int serializedSize()
      Returns the size (in bytes) of the marshalled object
      java.lang.String toString()  
      void writeTo​(java.io.DataOutput out)
      Write the entire state of the current object (including superclasses) to outstream.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • type

        public byte type
        Type of header: request or reply

      • req_id

        public long req_id
        The request id (unique for each blocking request), 0 means no response is expected

      • corrId

        public short corrId
        The unique ID of the associated RequestCorrelator

    • Constructor Detail

      • Header

        public Header()

      • Header

        public Header​(byte type,
              long req_id,
              short corr_id)
        Parameters:
        type - type of header (REQ/RSP)
        req_id - id of this header relative to ids of other requests originating from the same correlator
        corr_id - The ID of the RequestCorrelator from which

    • Method Detail

      • getMagicId

        public short getMagicId()
        Description copied from class: Header
        Returns the magic-ID. If defined in jg-magic-map.xml, the IDs need to be the same
        Specified by:
        getMagicId in class Header

      • create

        public java.util.function.Supplier<? extends Header> create()
        Description copied from interface: Constructable
        Creates an instance of the class implementing this interface

      • requestId

        public long requestId()

      • rspExpected

        public boolean rspExpected()

      • corrId

        public short corrId()

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class Header

      • writeTo

        public void writeTo​(java.io.DataOutput out)
             throws java.io.IOException
        Description copied from interface: Streamable
        Write the entire state of the current object (including superclasses) to outstream. Note that the output stream must not be closed
        Throws:
        java.io.IOException

      • readFrom

        public void readFrom​(java.io.DataInput in)
              throws java.io.IOException,
                     java.lang.ClassNotFoundException
        Description copied from interface: Streamable
        Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed
        Throws:
        java.io.IOException
        java.lang.ClassNotFoundException

      • serializedSize

        public int serializedSize()
        Description copied from interface: SizeStreamable
        Returns the size (in bytes) of the marshalled object