8.2. Byte Capping API Tokens

tornadod_fe now accepts the following new directives over the authentication API.

ReAuthInterval: <# seconds>

MaxTotalBytes: <# bytes>
       and/or
MaxArticleBytes: <# bytes>

MaxTotalBytes

The maximum number of bytes the current connection may download. Once reached, the connection will be terminated, unless a Re-Auth interval is defined. When MaxTotalBytes is used, all non-protocol commands are included in the tally, namely LIST, XOVER, ARTICLE, and HEAD.

MaxArticleBytes

Same as MaxTotalBytes, but only includes ARTICLE not XOVER, LIST, HEAD, or others. Can be used in lieu of or in addition to MaxTotalBytes. When MaxTotalBytes and MaxArticleBytes are used in conjunction, setting MaxArticleBytes higher than MaxTotalBytes means the article limit will never be met independently.

ReAuthInterval

When the authentication program issues ReAuthInterval to Tornado Front End, two effects occur:

  1. Connections will issue a re-authentication (to the Authentication Program) every # seconds. re-auth is non-user-interactive and transparent to the client. A response code of 281 indicates success. All other responses are interpreted as deny.

  2. When the ReAuth request is sent, or when a Disconnect occurs, the following will be passed to the authentication program:

Action: re-auth         * New action
TotalBytes: <# bytes>   * Number of total bytes this connection has downloaded
ArticleBytes: <# bytes> * Number of article bytes this connection has
downloaded
ArticleRequests: <#>    * Number of article requests
XoverBytes: <# bytes>   * Number of bytes sent via xover
XoverRequests: <#>      * Number of xover requests
Interface:
Hostname:
IPAddress:
SessionID:
Username:               * Username and password will only be provided if this connection was authenticated via username/pw earlier
Password: