[trafficserver] branch master updated: Doc: Document TSContCall.

[am...@apache.org]

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 77be1a5  Doc: Document TSContCall.
77be1a5 is described below

commit 77be1a530c7dc9c956be0a60b12fad5a45293da1
Author: Alan M. Carroll <am...@apache.org>
AuthorDate: Wed Aug 1 13:02:29 2018 -0500

    Doc: Document TSContCall.
---
 .../api/functions/TSContCall.en.rst                | 45 ++++++++++++++++++++++
 1 file changed, 45 insertions(+)

diff --git a/doc/developer-guide/api/functions/TSContCall.en.rst b/doc/developer-guide/api/functions/TSContCall.en.rst
index 501f0ac..9da6a31 100644
--- a/doc/developer-guide/api/functions/TSContCall.en.rst
+++ b/doc/developer-guide/api/functions/TSContCall.en.rst
@@ -30,3 +30,48 @@ Synopsis
 
 Description
 ===========
+
+Call the continuation :arg:`contp` as if from a hook with the event type :arg:`event` and data of
+:arg:`edata`. Presuming :arg:`contp` was created in a manner like::
+
+   TSContCreate(CallbackHandler, TSMutexCreate());
+
+Therefore there is a function::
+
+   int CallbackHandler(TSCont this, TSEvent id, void * data);
+
+As a result :func:`TSContCall` will effectively do::
+
+   return CallbackHandler(contp, event, edata);
+
+:func:`TSContCall` will check :arg:`contp` for a mutex. If there is a mutex an attempt will be made
+to lock that mutex. If either there is no mutex, or the mutex lock was acquired, the handler will be
+called directly. Otherwise there is a mutex and it was not successfully locked. In that case an
+event will be scheduled to dispatch as soon as possible, but not in the current call stack. The
+nature of event dispatch means the event will not be dispatched until the mutext can be locked. In
+all cases the handler in :arg:`contp` will be called with the same arguments. :func:`TSContCall`
+will return 0 if a mutex was present but the lock was not acquired. Otherwise it will return the
+value returned by the handler in :arg:`contp`.
+
+If the scheduling behavior of :func:`TSContCall` isn't appropriate, either :arg:`contp` must not
+have a mutex, or the plugin must acquire the lock on the mutex for :arg:`contp` before calling
+:func:`TSContCall`. See :func:`TSContMutexGet` and :func:`TSMutexLockTry` for mechanisms for doing
+the latter. This is what :func:`TSContCall` does internally, and should be done by the plugin only
+if a different approach for waiting for the lock is needed. The most common case is the code called
+by :func:`TSContCall` must complete before further code is executed at the call site. An alternative
+approach to handling the locking directly would be to split the call site in to two continuations,
+one of which is signalled (possibly via :func:`TSContCall`) from the original :func:`TSContCall`
+target.
+
+Note mutexes returned by :func:`TSMutexCreate` are recursive mutexes, therefore if the lock is
+already held on the thread of execution acquiring the lock again is very fast. Mutexes are also
+shareable so that the same mutex can be used for multiple continuations.::
+
+   TSMutex mutex = TSMutexCreate();
+   TSCont cont1 = TSContCreate(Handler1, mutex);
+   TSCont cont2 = TSContCreate(Handler2, mutex);
+
+In this example case, :code:`cont1` can assume the lock for :code:`cont2` is held. This should be
+considered carefully because for the same reason any thread protection between the continuations is
+removed. This works well for tightly coupled continuations that always operate in a fixed sequence.
+