doc/cmd/nncp-ack.texi

   1 @node nncp-ack
   2 @cindex packet acknowledgement
   3 @pindex nncp-ack
   4 @section nncp-ack
   5
   6 @example
   7 $ nncp-ack [options] NODE [PKT|rx]
   8 @end example
   9
  10 Sent acknowledgement of successful @option{PKT} (Base32-encoded hash)
  11 packet receipt. If @option{rx} is specified instead, then all
  12 @option{NODE}'s existing @code{rx} packets will be acknowledged.
  13
  14 General workflow with acknowledgement is following, assuming that
  15 Alice has some outbound packets for Bob:
  16
  17 @itemize
  18
  19 @item Transfer an encrypted packets, without deleting them locally:
  20
  21 @example
  22 alice$ nncp-xfer -keep -tx -node bob /mnt/shared
  23 @end example
  24
  25 @item On Bob's side retrieve those packets:
  26
  27 @example
  28 bob$ nncp-xfer -rx /mnt/shared
  29 @end example
  30
  31 That will also check if copied packets checksum is not mismatched.
  32
  33 @item Create ACK packets of received ones:
  34
  35 @example
  36 bob$ nncp-ack alice rx
  37 @end example
  38
  39 @item Send those newly created packets back to Alice:
  40
  41 @example
  42 bob$ nncp-xfer -tx /mnt/shared
  43 @end example
  44
  45 @item Get those acknowledgement packets and @ref{nncp-toss, toss} them:
  46
  47 @example
  48 alice$ nncp-xfer -rx /mnt/shared
  49 alice$ nncp-toss
  50 @end example
  51
  52 Each ACK packet will remove kept corresponding outbound packets, because
  53 Bob explicitly confirmed their receipt.
  54
  55 @end itemize
  56
  57 Similarly you can use it with @command{@ref{nncp-bundle}}, but do not
  58 forget that by default it does not do checksumming of the packets, so
  59 you should either use its @option{-check} option, or run
  60 @command{@ref{nncp-check}} after.