vgl 1.0.0
Virtual Globe Library: API reference
Loading...
Searching...
No Matches
vgl_http_reader_create_info Struct Reference

#include <vgl/defaults.h>

Public Attributes

uint32_t struct_size
 
uint32_t max_connection_count
 
const vgl_allocator_interface * allocator
 
const vgl_io_interface * fallback
 
double timeout
 
const char * user_agent
 

Member Data Documentation

◆ struct_size

uint32_t vgl_http_reader_create_info::struct_size

◆ max_connection_count

uint32_t vgl_http_reader_create_info::max_connection_count

Connections to each server at most. 0 selects 8. Ignored in a browser.

◆ allocator

const vgl_allocator_interface* vgl_http_reader_create_info::allocator

Optional. Allocator for the reader and its reads; must be thread-safe.

◆ fallback

const vgl_io_interface* vgl_http_reader_create_info::fallback

Optional. Reads the URIs that are not HTTP, such as a file reader's interface (vgl_file_reader_io_interface_get) or a host's own; without it, they complete with VGL_RESULT_NOT_FOUND, or in a browser are fetched. The table is copied; the object behind its user_data must outlive the reader.

◆ timeout

double vgl_http_reader_create_info::timeout

Seconds a read may take before it fails with VGL_RESULT_IO_ERROR. 0 selects 30.

◆ user_agent

const char* vgl_http_reader_create_info::user_agent

Optional. The User-Agent header, copied; null selects "vgl/<version>". Ignored in a browser.


The documentation for this struct was generated from the following file: