ark::comms::HttpServerConfig

Defined in header “ark/comms/http_server_config.hh”.

A configuration structure for the HTTP server. Allows you to define some common properties of the server.

Variables

  • comms::NetworkAddress listen_address
    Network address that the server should listen on.

  • size_t maximum_receive_buffer_size= 64ULL * 1024 * 1024
    Maximum size of the receive buffer that is supported by this server. Higher numbers allow for larger PUT requests, but will use more memory for storage.

  • size_t maximum_write_buffer_size= 128ULL * 1024 * 1024
    Maximum size of messages being written to the client. Higher numbers allow for the client to ‘back up’ for longer periods of time (on websockets) or support larger GET requests, but will use more memory for storage.

  • size_t maximum_open_requests= 1024
    Maximum number of connected clients that can be serviced at any point in time. Limit this to avoid overloading the server with too many open requests (and potentially running out of memory).

  • std::chrono::nanoseconds throttled_websocket_write_timeout_= std::chrono::seconds{5}
    Timeout used for throttling websocket writers, when writing messages. If a client has not acknowledged a write for this period of time, the connection will be closed.