net.i2p.router.crypto.ratchet

## Class RatchetPayload.Block

- java.lang.Object
- - net.i2p.router.crypto.ratchet.RatchetPayload.Block

- Direct Known Subclasses:
    RatchetPayload.AckBlock, RatchetPayload.AckRequestBlock, RatchetPayload.DateTimeBlock, RatchetPayload.GarlicBlock, RatchetPayload.NextKeyBlock, RatchetPayload.OptionsBlock, RatchetPayload.PaddingBlock, RatchetPayload.PNBlock, RatchetPayload.TerminationBlock
  Enclosing class:
    RatchetPayload

      public abstract static class RatchetPayload.Block
      extends Object

  Base class for blocks to be transmitted. Not used for receive; we use callbacks instead.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `Block(int ttype)`

  - ### Method Summary

    All Methods Instance Methods Abstract Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `abstract int` | `getDataLength()`
    `int` | `getTotalLength()`
    `String` | `toString()`
    `int` | `write(byte[] tgt, int off)`
    `abstract int` | `writeData(byte[] tgt, int off)`

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

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

- - ### Constructor Detail

    - #### Block

          public Block(int ttype)

  - ### Method Detail

    - #### getDataLength

          public abstract int getDataLength()

      Returns:
        the size of the block, NOT including the 3 byte header (type and size)

    - #### getTotalLength

          public int getTotalLength()

      Returns:
        the size of the block, including the 3 byte header (type and size)

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`

    - #### write

          public int write(byte[] tgt,
                           int off)

      Returns:
        new offset

    - #### writeData

          public abstract int writeData(byte[] tgt,
                                        int off)

      Returns:
        new offset