Main Page | Modules | Namespace List | Class Hierarchy | Class List | File List | Class Members | File Members

SBinet.h File Reference

#include "VXIinet.h"
#include "VXIlog.h"
#include "VXIcache.h"
#include "VXIheaderPrefix.h"
#include "VXIheaderSuffix.h"

SBInet Properties

Properties used in the VXIMap configParams arguments to SBinetInitEx.

#define SBINET_EXTENSION_RULES   L"com.vocalocity.inet.extension.rules"
 Rules for mapping file extensions to MIME content types, used for that purpose when accessing local files and file:// URLs.
#define SBINET_PROXY_RULES   L"com.vocalocity.inet.proxy.rules"
 Rules for determining the proxy to use for given domains.
#define SBINET_PAGE_LOADING_TIMEOUT   L"com.vocalocity.inet.pageLoadingTimeout"
 Default timeout for fetching a page when not explicitely specified through the INET_TIMEOUT_DOWNLOAD property in the properties VXIMap argument of the VXIinterface::Open() function.
#define SBINET_PAGE_LOADING_TIMEOUT_DEFAULT   60000
 Default value for SBINET_PAGE_LOADING_TIMEOUT.
#define SBINET_FRESHNESS_FRACTION   L"com.vocalocity.inet.freshnessFraction"
 Properties used to estimate the cache lifetime of URIs that only have the Last-Modified header defined.
#define SBINET_FRESHNESS_LIFETIME   L"com.vocalocity.inet.freshnessLifetime"
#define SBINET_FRESHNESS_FRACTION_DEFAULT   0.1
 Default value for SBINET_FRESHNESS_FRACTION.
#define SBINET_FRESHNESS_LIFETIME_DEFAULT   86400
 Default value for SBINET_FRESHNESS_LIFETIME.
#define SBINET_MAX_LIFETIME   L"com.vocalocity.inet.maxLifetime"
 If returned paged from web server do not contain any caching information nor any Last-Modified header, this is the amount of time (number of seconds) that the page will be considered fresh before a new HTTP request is performed for this page.
#define SBINET_MAX_LIFETIME_DEFAULT   0
 Default value for SBINET_MAX_LIFETIME.
#define SBINET_POST_CONTINUE_TIMEOUT   L"com.vocalocity.inet.postContinueTimeout"
 Number of milliseconds that a POST-request should wait for a response.
#define SBINET_POST_CONTINUE_TIMEOUT_DEFAULT   5000
 Default value for SBINET_POST_CONTINUE_TIMEOUT.
#define SBINET_USER_AGENT_NAME   L"com.vocalocity.inet.userAgentName"
 Property specifiying tsent in all HTTP messages.
#define SBINET_PERSISTENT_CONNECTIONS   L"com.vocalocity.inet.usePersistentConnections"
 Properties allowing to disable persistent connections.
#define SBINET_DEFAULT_MIME_TYPE   L"com.vocalocity.inet.defaultMimeType"
 Default MIME type returned when it was not possible to determine the MIME type of a file URI from its extension or when an HTTP server does not return MIME type information.

Defines

#define SBINET_API   SYMBOL_IMPORT_DECL
#define SBINET_USER_AGENT_NAME_DEFAULT   L"OpenVXITestApp/" VXI_CURRENT_VERSION_STR
 Default value for the User Agent Name parameter of SBinetInit().

Functions

SBINET_API VXIinetResult SBinetInit (VXIlogInterface *log, const VXIunsigned diagLogBase, const VXIchar *reserved1, const VXIint reserved2, const VXIint reserved3, const VXIint reserved4, const VXIchar *proxyServer, const VXIulong proxyPort, const VXIchar *userAgentName, const VXIMap *extensionRules, const VXIVector *reserved)
 Global platform initialization of SBinet.
SBINET_API VXIinetResult SBinetInitEx (VXIlogInterface *log, const VXIunsigned diagLogBase, const VXIMap *configParams)
 Global platform initialization (extended version) of SBinet.
SBINET_API VXIinetResult SBinetShutDown (VXIlogInterface *log)
 Global platform shutdown of SBinet.
SBINET_API VXIinetResult SBinetCreateResource (VXIlogInterface *log, VXIcacheInterface *cache, VXIinetInterface **inet)
 Create a new inet service handle.
SBINET_API VXIinetResult SBinetDestroyResource (VXIinetInterface **inet)
 Destroy the interface and free internal resources.


Define Documentation

#define SBINET_API   SYMBOL_IMPORT_DECL
 


Generated on Wed Jun 1 12:50:18 2005 for OpenVXI by  doxygen 1.4.2