.\" Man page generated from reStructuredText. . .TH "TSHTTPOVERRIDABLECONFIG" "3ts" "January 24, 2017" "7.0" "Apache Traffic Server" .SH NAME TSHttpOverridableConfig \- . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .SH SYNOPSIS .sp \fI#include \fP .INDENT 0.0 .TP .B TSOverridableConfigKey .UNINDENT .INDENT 0.0 .TP .B TSReturnCode TSHttpTxnConfigIntSet(TSHttpTxn\fI\ txnp\fP, TSOverridableConfigKey\fI\ key\fP, TSMgmtInt\fI\ value\fP) .UNINDENT .INDENT 0.0 .TP .B TSReturnCode TSHttpTxnConfigIntGet(TSHttpTxn\fI\ txnp\fP, TSOverridableConfigKey\fI\ key\fP, TSMgmtInt*\fI\ value\fP) .UNINDENT .INDENT 0.0 .TP .B TSReturnCode TSHttpTxnConfigFloatSet(TSHttpTxn\fI\ txnp\fP, TSOverridableConfigKey\fI\ key\fP, TSMgmtFloat\fI\ value\fP) .UNINDENT .INDENT 0.0 .TP .B TSReturnCode TSHttpTxnConfigFloatGet(TSHttpTxn\fI\ txnp\fP, TSOverridableConfigKey\fI\ key\fP, TSMgmtFloat*\fI\ value\fP) .UNINDENT .INDENT 0.0 .TP .B TSReturnCode TSHttpTxnConfigStringSet(TSHttpTxn\fI\ txnp\fP, TSOverridableConfigKey\fI\ key\fP, const char*\fI\ value\fP, int\fI\ length\fP) .UNINDENT .INDENT 0.0 .TP .B TSReturnCode TSHttpTxnConfigStringGet(TSHttpTxn\fI\ txnp\fP, TSOverridableConfigKey\fI\ key\fP, const char**\fI\ value\fP, int*\fI\ length\fP) .UNINDENT .INDENT 0.0 .TP .B TSReturnCode TSHttpTxnConfigFind(const char*\fI\ name\fP, int\fI\ length\fP, TSOverridableConfigKey*\fI\ key\fP, TSRecordDataType*\fI\ type\fP) .UNINDENT .SH DESCRIPTION .sp Some of the values that are set in \fBrecords.config\fP can be changed for a specific transaction. It is important to note that these functions change the configuration values stored for the transation, which is not quite the same as changing the actual operating values of the transaction. The critical effect is the value must be changed before it is used by the transaction \- after that, changes will not have any effect. .sp All of the \fB\&...Get\fP functions store the internal value in the storage indicated by the \fIvalue\fP argument. For strings \fIlength*\fP will receive the length of the string. .sp The values are identified by the enumeration \fBTSOverridableConfigKey\fP\&. String values can be used indirectly by first passing them to \fI\%TSHttpTxnConfigFind()\fP which, if the string matches an overridable value, return the key and data type. .SH CONFIGURATIONS .sp The following configurations (from \fBrecords.config\fP) are overridable. .nf \fBproxy.config.url_remap.pristine_host_hdr\fP \fBproxy.config.http.chunking_enabled\fP \fBproxy.config.http.negative_caching_enabled\fP \fBproxy.config.http.negative_caching_lifetime\fP \fBproxy.config.http.cache.when_to_revalidate\fP \fBproxy.config.http.keep_alive_enabled_in\fP \fBproxy.config.http.keep_alive_enabled_out\fP \fBproxy.config.http.keep_alive_post_out\fP \fBproxy.config.net.sock_recv_buffer_size_out\fP \fBproxy.config.net.sock_send_buffer_size_out\fP \fBproxy.config.net.sock_option_flag_out\fP \fBproxy.config.http.forward.proxy_auth_to_parent\fP \fBproxy.config.http.anonymize_remove_from\fP \fBproxy.config.http.anonymize_remove_referer\fP \fBproxy.config.http.anonymize_remove_user_agent\fP \fBproxy.config.http.anonymize_remove_cookie\fP \fBproxy.config.http.anonymize_remove_client_ip\fP \fBproxy.config.http.insert_client_ip\fP \fBproxy.config.http.response_server_enabled\fP \fBproxy.config.http.insert_squid_x_forwarded_for\fP \fBproxy.config.http.server_tcp_init_cwnd\fP \fBproxy.config.http.send_http11_requests\fP \fBproxy.config.http.cache.http\fP \fBproxy.config.http.cache.cluster_cache_local\fP \fBproxy.config.http.cache.ignore_client_no_cache\fP \fBproxy.config.http.cache.ignore_client_cc_max_age\fP \fBproxy.config.http.cache.ims_on_client_no_cache\fP \fBproxy.config.http.cache.ignore_server_no_cache\fP \fBproxy.config.http.cache.cache_responses_to_cookies\fP \fBproxy.config.http.cache.ignore_authentication\fP \fBproxy.config.http.cache.cache_urls_that_look_dynamic\fP \fBproxy.config.http.cache.required_headers\fP \fBproxy.config.http.insert_request_via_str\fP \fBproxy.config.http.insert_response_via_str\fP \fBproxy.config.http.cache.heuristic_min_lifetime\fP \fBproxy.config.http.cache.heuristic_max_lifetime\fP \fBproxy.config.http.cache.guaranteed_min_lifetime\fP \fBproxy.config.http.cache.guaranteed_max_lifetime\fP \fBproxy.config.http.cache.max_stale_age\fP \fBproxy.config.http.keep_alive_no_activity_timeout_in\fP \fBproxy.config.http.keep_alive_no_activity_timeout_out\fP \fBproxy.config.http.transaction_no_activity_timeout_in\fP \fBproxy.config.http.transaction_no_activity_timeout_out\fP \fBproxy.config.http.transaction_active_timeout_out\fP \fBproxy.config.websocket.no_activity_timeout\fP \fBproxy.config.websocket.active_timeout\fP \fBproxy.config.http.origin_max_connections\fP \fBproxy.config.http.connect_attempts_max_retries\fP \fBproxy.config.http.connect_attempts_max_retries_dead_server\fP \fBproxy.config.http.connect_attempts_rr_retries\fP \fBproxy.config.http.connect_attempts_timeout\fP \fBproxy.config.http.post_connect_attempts_timeout\fP \fBproxy.config.http.down_server.cache_time\fP \fBproxy.config.http.down_server.abort_threshold\fP \fBproxy.config.http.cache.fuzz.time\fP \fBproxy.config.http.cache.fuzz.min_time\fP \fBproxy.config.http.doc_in_cache_skip_dns\fP \fBproxy.config.http.background_fill_active_timeout\fP \fBproxy.config.http.response_server_str\fP \fBproxy.config.http.cache.heuristic_lm_factor\fP \fBproxy.config.http.cache.fuzz.probability\fP \fBproxy.config.http.background_fill_completed_threshold\fP \fBproxy.config.net.sock_packet_mark_out\fP \fBproxy.config.net.sock_packet_tos_out\fP \fBproxy.config.http.insert_age_in_response\fP \fBproxy.config.http.chunking.size\fP \fBproxy.config.http.flow_control.enabled\fP \fBproxy.config.http.flow_control.low_water\fP \fBproxy.config.http.flow_control.high_water\fP \fBproxy.config.http.cache.range.lookup\fP \fBproxy.config.http.normalize_ae_gzip\fP \fBproxy.config.http.default_buffer_size\fP \fBproxy.config.http.default_buffer_water_mark\fP \fBproxy.config.http.request_header_max_size\fP \fBproxy.config.http.response_header_max_size\fP \fBproxy.config.http.negative_revalidating_enabled\fP \fBproxy.config.http.negative_revalidating_lifetime\fP \fBproxy.config.http.cache.range.write\fP \fBproxy.config.http.global_user_agent_header\fP \fBproxy.config.http.slow.log.threshold\fP \fBproxy.config.http.cache.generation\fP \fBproxy.config.body_factory.template_base\fP \fBproxy.config.http.cache.open_write_fail_action\fP \fBproxy.config.http.redirection_enabled\fP \fBproxy.config.http.number_of_redirections\fP \fBproxy.config.http.cache.max_open_write_retries\fP \fBproxy.config.http.redirect_use_orig_cache_key\fP .fi .sp .SH EXAMPLES .sp Enable \fItransaction buffer control\fP with a high water mark of \fB262144\fP and a low water mark of \fB65536\fP\&. .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C int callback(TSCont contp, TSEvent event, void* data) { TSHttpTxn txnp = static_cast(data); TSHttpTxnConfigIntSet(txnp, TS_CONFIG_HTTP_FLOW_CONTROL_ENABLED, 1); TSHttpTxnConfigIntSet(txnp, TS_CONFIG_HTTP_FLOW_CONTROL_HIGH_WATER_MARK, 262144); TSHttpTxnConfigIntSet(txnp, TS_CONFIG_HTTP_FLOW_CONTROL_LOWER_WATER_MARK, 65536); return 0; } .ft P .fi .UNINDENT .UNINDENT .SH SEE ALSO .sp \fITSAPI(3ts)\fP .SH COPYRIGHT 2015, dev@trafficserver.apache.org .\" Generated by docutils manpage writer. .