src/plugins/http_static/http_static.api

   1
   2 /** \file
   3     This file defines static http server control-plane API messages
   4 */
   5 option version = "2.0.0";
   6
   7 /** \brief Configure and enable the static http server
   8     @param client_index - opaque cookie to identify the sender
   9     @param context - sender context, to match reply w/ request
  10     @param fifo_size - size (in bytes) of the session FIFOs
  11     @param cache_size_limit - size (in bytes) of the in-memory file data cache
  12     @param prealloc_fifos - number of preallocated fifos (usually 0)
  13     @param private_segment_size - fifo segment size (usually 0)
  14     @param www_root - html root path
  15     @param uri - bind URI, defaults to "tcp://0.0.0.0/80"
  16 */
  17
  18 autoreply define http_static_enable {
  19     /* Client identifier, set from api_main.my_client_index */
  20     u32 client_index;
  21
  22     /* Arbitrary context, so client can match reply to request */
  23     u32 context;
  24     /* Typical options */
  25     u32 fifo_size;
  26     u32 cache_size_limit;
  27     /* Unusual options */
  28     u32 prealloc_fifos;
  29     u32 private_segment_size;
  30
  31     /* Root of the html path */
  32     string www_root[limit=256];
  33     /* The bind URI */
  34     string uri[limit=256];
  35 };