doc/call.texi

   1 @node Call
   2 @unnumbered Call configuration
   3
   4 Call is a rule when and how node can be called.
   5
   6 Example list of call structures:
   7
   8 @verbatim
   9 calls: [
  10     {
  11         cron: "*/1 * * * MON-FRI"
  12         onlinedeadline: 3600
  13         nice: PRIORITY+10
  14
  15         autotoss: true
  16         autotoss-doseen: true
  17     },
  18     {
  19         cron: "30 * * * SAT,SUN"
  20         onlinedeadline: 1800
  21         maxonlinetime: 1750
  22         nice: NORMAL
  23         rxrate: 10
  24         txrate: 20
  25     },
  26     {
  27         cron: "0 * * * SAT,SUN"
  28         xx: rx
  29         addr: lan
  30     },
  31     {
  32         cron: "*/5 * * * * * *"
  33         when-tx-exists: true
  34         nock: true
  35     },
  36 ]
  37 @end verbatim
  38
  39 tells that on work days of the week call that node every minute,
  40 disconnect after an hour of inactivity and process only relatively high
  41 priority packets (presumably mail ones). So we connect and hold
  42 connection for very long time to pass only emails. On weekends call that
  43 node only each half-hour for processing high-priority packets. Also only
  44 on weekends try to connect to that node every hour only using LAN
  45 address and only receiving any (any priority) packets (assume that low
  46 priority huge file transmission are done additionally via offline
  47 connections).
  48
  49 It contains the following fields (only @emph{cron} is required):
  50
  51 @table @emph
  52
  53 @item cron
  54 @include cronexpr.texi
  55
  56 @item nice
  57 Optional. Use that @ref{Niceness, niceness} during the call (255 is used
  58 otherwise).
  59
  60 @item xx
  61 Optional. Either @verb{|rx|} or @verb{|tx|}. Tells only to either to
  62 receive or to transmit data during that call.
  63
  64 @item addr
  65 Optional. Call only that address, instead of trying all from
  66 @ref{CfgAddrs, @emph{addrs}} configuration option. It can be either key
  67 from @emph{addrs} dictionary, or an ordinary @option{addr:port}.
  68
  69 @item rxrate/txrate
  70 Optional. Override @ref{CfgXxRate, @emph{rxrate/txrate}} configuration
  71 option when calling.
  72
  73 @item onlinedeadline
  74 Optional. Override @ref{CfgOnlineDeadline, @emph{onlinedeadline}}
  75 configuration option when calling.
  76
  77 @item maxonlinetime
  78 Optional. Override @ref{CfgMaxOnlineTime, @emph{maxonlinetime}}
  79 configuration option when calling.
  80
  81 @item autotoss, -doseen, -nofile, -nofreq, -noexec, -notrns
  82 Optionally enable auto tossing: run tosser on node's spool every second
  83 during the call. You can control either are @file{.seen} files must be
  84 created, or skip any kind of packet processing.
  85
  86 @item when-tx-exists
  87 Call only if packets for sending exists.
  88
  89 @anchor{CfgNoCK}
  90 @item nock
  91 NoCK (no-checksumming) tells not to do checksumming of received files,
  92 assuming that it will be done for example with @ref{nncp-check} command
  93 later. That can help minimizing time spent online, because HDD won't do
  94 simultaneous reading of the data for checksumming and writing of the
  95 received one, but just sequential writing of the file. Pay attention
  96 that you have to make a call to remote node after checksumming is done,
  97 to send notification about successful packet reception.
  98
  99 @end table