Package net.i2p.client.streaming.impl

Class PacketLocal

java.lang.Object
net.i2p.client.streaming.impl.Packet
net.i2p.client.streaming.impl.PacketLocal
All Implemented Interfaces:
MessageOutputStream.WriteStatus
class PacketLocal extends Packet implements MessageOutputStream.WriteStatus
This is the class used for outbound packets. coordinate local attributes about a packet - send time, ack time, number of retries, etc.

  • Constructor Details

  • Method Details

    • setOptionalFrom

      public void setOptionalFrom()
      This sets the from field in the packet to the Destination for the session provided in the constructor. This also sets flag FLAG_FROM_INCLUDED. Also, as of 0.9.39, sets the offline signing data if supported by the session.
      Since:
      0.9.39 moved from super

    • getTo

      public Destination getTo()

    • getKeyUsed

      @Deprecated public SessionKey getKeyUsed()
      Deprecated.
      should always return null

    • setKeyUsed

      @Deprecated public void setKeyUsed(SessionKey key)
      Deprecated.
      I2PSession throws out the tags

    • getTagsSent

      @Deprecated public Set<SessionTag> getTagsSent()
      Deprecated.
      should always return null or an empty set

    • setTagsSent

      @Deprecated public void setTagsSent(Set<SessionTag> tags)
      Deprecated.
      I2PSession throws out the tags

    • shouldSign

      public boolean shouldSign()

    • getCreatedOn

      public long getCreatedOn()

    • getLifetime

      public long getLifetime()

    • incrementSends

      public void incrementSends()

    • ackReceived

      public void ackReceived()

    • cancelled

      public void cancelled()

    • getAckTime

      public int getAckTime()
      how long after packet creation was it acked?
      Returns:
      how long after packet creation the packet was ACKed in ms

    • getNumSends

      public int getNumSends()

    • getLastSend

      public long getLastSend()

    • getConnection

      public Connection getConnection()
      Returns:
      null if not bound

    • incrementNACKs

      public void incrementNACKs()
      Will force a fast restransmit on the 3rd call (FAST_RETRANSMIT_THRESHOLD) but only if it's the lowest unacked (see Connection.ResendPacketEvent)

    • getNACKs

      public int getNACKs()
      Warning: This is different than getNacks() in super
      Returns:
      Number of times this packet has been nacked

    • getTimeout

      public int getTimeout()
      Used by PacketQueue to feed an expiration to the router.
      Returns:
      time from now, not absolute time. May be zero if unset.
      Since:
      0.9.46

    • setTimeout

      public void setTimeout(int timeout)
      Parameters:
      timeout - time from now, not absolute time
      Since:
      0.9.46

    • writeSignedPacket

      public int writeSignedPacket(byte[] buffer, int offset) throws IllegalStateException
      Sign and write the packet to the buffer (starting at the offset) and return the number of bytes written.
      Parameters:
      buffer - data to be written
      offset - starting point in the buffer
      Returns:
      Count of bytes written
      Throws:
      IllegalStateException - if there is data missing or otherwise b0rked
      Since:
      0.9.20 moved from Packet

    • formatAsString

      public StringBuilder formatAsString()
      Overrides:
      formatAsString in class Packet

    • waitForAccept

      public void waitForAccept(int maxWaitMs) throws IOException, InterruptedException
      Blocks until outbound window is not full. See Connection.packetSendChoke().
      Specified by:
      waitForAccept in interface MessageOutputStream.WriteStatus
      Parameters:
      maxWaitMs - MessageOutputStream is the only caller, generally with -1
      Throws:
      IOException
      InterruptedException

    • waitForCompletion

      public void waitForCompletion(int maxWaitMs) throws IOException, InterruptedException
      block until the packet is acked from the far end
      Specified by:
      waitForCompletion in interface MessageOutputStream.WriteStatus
      Parameters:
      maxWaitMs - -1 = forever
      Throws:
      IOException
      InterruptedException

    • writeAccepted

      public boolean writeAccepted()
      Description copied from interface: MessageOutputStream.WriteStatus
      Was the write was accepted. aka did the socket not close?
      Specified by:
      writeAccepted in interface MessageOutputStream.WriteStatus

    • writeFailed

      public boolean writeFailed()
      Description copied from interface: MessageOutputStream.WriteStatus
      did the write fail?
      Specified by:
      writeFailed in interface MessageOutputStream.WriteStatus

    • writeSuccessful

      public boolean writeSuccessful()
      Description copied from interface: MessageOutputStream.WriteStatus
      did the write succeed?
      Specified by:
      writeSuccessful in interface MessageOutputStream.WriteStatus

    • logTCPDump

      public void logTCPDump()
      Generate a pcap/tcpdump-compatible format, so we can use standard debugging tools.