This is an automated email from the ASF dual-hosted git repository.
amc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficserver.git
The following commit(s) were added to refs/heads/master by this push:
new 41a2a67 Doc: Fix a number of minor errors, add some documentation for
the thread affinity plugin API.
41a2a67 is described below
commit 41a2a67186f690b30acac93adcad8f306c6ed91a
Author: Alan M. Carroll <[email protected]>
AuthorDate: Fri Jan 25 20:32:36 2019 -0600
Doc: Fix a number of minor errors, add some documentation for the thread
affinity plugin API.
---
doc/Makefile.am | 4 +---
doc/admin-guide/files/ssl_server_name.yaml.en.rst | 2 +-
doc/admin-guide/plugins/cookie_remap.en.rst | 5 +----
doc/admin-guide/plugins/index.en.rst | 1 +
doc/admin-guide/plugins/slice.en.rst | 2 +-
doc/appendices/glossary.en.rst | 7 +++++++
.../api/functions/TSContThreadAffinityClear.en.rst | 2 +-
.../api/functions/TSContThreadAffinityGet.en.rst | 2 +-
.../api/functions/TSContThreadAffinitySet.en.rst | 2 +-
doc/developer-guide/api/functions/TSThreadSelf.en.rst | 3 +++
doc/developer-guide/api/functions/TSTypes.en.rst | 14 ++++++++++++++
11 files changed, 32 insertions(+), 12 deletions(-)
diff --git a/doc/Makefile.am b/doc/Makefile.am
index caa7db7..f6c174f 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -48,12 +48,10 @@ doxygen: Doxyfile
PAPER = letter
BUILDDIR = docbuild
-# Internal variables.
# [amc] LaTex apparently doesn't work as of Sphinx 1.6.1
# see https://media.readthedocs.org/pdf/sphinx/1.6.3/sphinx.pdf
# section 24.3.2 around page 247, third item for 'NotImplementedError', so
this is kind of useless.
-PAPEROPT_a4 = -t latex_a4
-PAPEROPT_letter = -t latex_letter
+
ALLSPHINXOPTS = $(SPHINXOPTS)
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(SPHINXOPTS)
diff --git a/doc/admin-guide/files/ssl_server_name.yaml.en.rst
b/doc/admin-guide/files/ssl_server_name.yaml.en.rst
index ac8068b..6f2f1a0 100644
--- a/doc/admin-guide/files/ssl_server_name.yaml.en.rst
+++ b/doc/admin-guide/files/ssl_server_name.yaml.en.rst
@@ -74,7 +74,7 @@ verify_client One of the values :code:`NONE`,
:code:`MODERATE`, or :
By default this is
:ts:cv:`proxy.config.ssl.client.certification_level`.
valid_tls_versions_in This specifies the list of TLS protocols that will
be offered to user agents during
- the TLS negotiaton. This replaces the global
settings in :ts:cv:`proxy.config.ssl.TSLv1`,
+ the TLS negotiaton. This replaces the global
settings in :ts:cv:`proxy.config.ssl.TLSv1`,
:ts:cv:`proxy.config.ssl.TLSv1_1`,
:ts:cv:`proxy.config.ssl.TLSv1_2`,
and :ts:cv:`proxy.config.ssl.TLSv1_3`. The potential
values are TLSv1, TLSv1_1, TLSv1_2, and
TLSv1_3. You must list all protocols that |TS|
should offer to the client when using
diff --git a/doc/admin-guide/plugins/cookie_remap.en.rst
b/doc/admin-guide/plugins/cookie_remap.en.rst
index f79074b..24b5d94 100644
--- a/doc/admin-guide/plugins/cookie_remap.en.rst
+++ b/doc/admin-guide/plugins/cookie_remap.en.rst
@@ -19,11 +19,8 @@
.. _admin-plugins-cookie_remap:
-============================================================
Cookie Based Routing Inside TrafficServer Using cookie_remap
-============================================================
-
-----
+************************************************************
* `Cookie Based Routing Inside TrafficServer Using cookie_remap
<#cookie-based-routing-inside-trafficserver-using-cookie_remap>`_
diff --git a/doc/admin-guide/plugins/index.en.rst
b/doc/admin-guide/plugins/index.en.rst
index 4f750a3..de8e884 100644
--- a/doc/admin-guide/plugins/index.en.rst
+++ b/doc/admin-guide/plugins/index.en.rst
@@ -52,6 +52,7 @@ Plugins that are considered stable are installed by default
in |TS| releases.
Cache Promotion Policies <cache_promote.en>
Combo Handler <combo_handler.en>
Configuration Remap <conf_remap.en>
+ Cookie Remap <cookie_remap.en>
ESI <esi.en>
Escalate <escalate.en>
Compress <compress.en>
diff --git a/doc/admin-guide/plugins/slice.en.rst
b/doc/admin-guide/plugins/slice.en.rst
index 34a219e..86ad1a6 100644
--- a/doc/admin-guide/plugins/slice.en.rst
+++ b/doc/admin-guide/plugins/slice.en.rst
@@ -37,7 +37,7 @@ plugin allows the following:
devices and within cache groups.
Configuration
-============
+=============
This plugin is intended for use as a remap plugin and is
configured in :file:`remap.config`.
diff --git a/doc/appendices/glossary.en.rst b/doc/appendices/glossary.en.rst
index 282d00b..863853c 100644
--- a/doc/appendices/glossary.en.rst
+++ b/doc/appendices/glossary.en.rst
@@ -35,6 +35,13 @@ Glossary
invoked to continue the suspended processing. This can be considered
similar to co-routines.
+ event loop
+ Code that executes callbacks in continuations from a queue of events.
+
+ event thread
+ A thread created by |TS| that has an :term:`event loop`. Event loops
drive activity in |TS|
+ and are responsible for all network I/O handling, hook processing, and
scheduled events.
+
session
A single connection from a client to Traffic Server, covering all
requests and responses on that connection. A session starts when the
diff --git a/doc/developer-guide/api/functions/TSContThreadAffinityClear.en.rst
b/doc/developer-guide/api/functions/TSContThreadAffinityClear.en.rst
index 9846535..ef17ae0 100644
--- a/doc/developer-guide/api/functions/TSContThreadAffinityClear.en.rst
+++ b/doc/developer-guide/api/functions/TSContThreadAffinityClear.en.rst
@@ -19,7 +19,7 @@
.. default-domain:: c
TSContThreadAffinityClear
-**************
+*************************
Synopsis
========
diff --git a/doc/developer-guide/api/functions/TSContThreadAffinityGet.en.rst
b/doc/developer-guide/api/functions/TSContThreadAffinityGet.en.rst
index c31363c..2bc4955 100644
--- a/doc/developer-guide/api/functions/TSContThreadAffinityGet.en.rst
+++ b/doc/developer-guide/api/functions/TSContThreadAffinityGet.en.rst
@@ -19,7 +19,7 @@
.. default-domain:: c
TSContThreadAffinityGet
-**************
+***********************
Synopsis
========
diff --git a/doc/developer-guide/api/functions/TSContThreadAffinitySet.en.rst
b/doc/developer-guide/api/functions/TSContThreadAffinitySet.en.rst
index cae2903..5b35513 100644
--- a/doc/developer-guide/api/functions/TSContThreadAffinitySet.en.rst
+++ b/doc/developer-guide/api/functions/TSContThreadAffinitySet.en.rst
@@ -19,7 +19,7 @@
.. default-domain:: c
TSContThreadAffinitySet
-**************
+***********************
Synopsis
========
diff --git a/doc/developer-guide/api/functions/TSThreadSelf.en.rst
b/doc/developer-guide/api/functions/TSThreadSelf.en.rst
index 7c213c2..b0d0590 100644
--- a/doc/developer-guide/api/functions/TSThreadSelf.en.rst
+++ b/doc/developer-guide/api/functions/TSThreadSelf.en.rst
@@ -30,3 +30,6 @@ Synopsis
Description
===========
+
+Return an instance of :type:`TSThread` that identifies the current thread.
This must be called from
+within a |TS| create thread context. That is any thread created by the |TS|
core or via the |TS| API.
diff --git a/doc/developer-guide/api/functions/TSTypes.en.rst
b/doc/developer-guide/api/functions/TSTypes.en.rst
index 6b18d9a..8abbea6 100644
--- a/doc/developer-guide/api/functions/TSTypes.en.rst
+++ b/doc/developer-guide/api/functions/TSTypes.en.rst
@@ -150,6 +150,20 @@ more widely. Those are described on this page.
.. type:: TSThread
+ This represents an internal |TS| thread, created by the |TS| core. It is
an opaque type which
+ can be used only to check for equality / inequality, and passed to API
functions. An instance
+ that refers to the current thread can be obtained with
:func:`TSThreadSelf`.
+
+.. type:: TSEventThread
+
+ This type represents an :term:`event thread`. It is an opaque which is
used to specify a
+ particular event processing thread in |TS|. If plugin code is executing
in an event thread
+ (which will be true if called from a hook or a scheduled event) then the
current event thread
+ can be obtained via :func:`TSEventThreadSelf`.
+
+ A :code:`TSEventThread` is also a :type:`TSThread` and can be passed as
an argument to any
+ parameter of type :type:`TSThread`.
+
.. type:: TSThreadFunc
.. type:: TSUuidVersion
