[trafficserver] branch master updated: Add more information about event data to 'hook add' API function documentation.

[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 f29d68f  Add more information about event data to 'hook add' API function documentation.
f29d68f is described below

commit f29d68f9b1fd8f43d3915c2ba00f7d695fb14a9f
Author: Walter Karas <wk...@oath.com>
AuthorDate: Wed Jan 2 15:46:01 2019 -0600

    Add more information about event data to 'hook add' API function documentation.
---
 doc/developer-guide/api/functions/TSHttpHookAdd.en.rst | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/doc/developer-guide/api/functions/TSHttpHookAdd.en.rst b/doc/developer-guide/api/functions/TSHttpHookAdd.en.rst
index d21bb4b..3019be0 100644
--- a/doc/developer-guide/api/functions/TSHttpHookAdd.en.rst
+++ b/doc/developer-guide/api/functions/TSHttpHookAdd.en.rst
@@ -77,9 +77,11 @@ function will be TS_EVENT_HTTP_READ_REQUEST_HDR.
 When a continuation is triggered by a hook, the actual type of the event data
 (the void pointer passed as the third parameter to the continuation function) is
 determined by which hook it is.  For example, for the hook ID TS_HTTP_TXN_CLOSE_HOOK,
-the event data is of type TSHttpTxn.  This is the case regardless of whether the
+the event data is of type :type:`TSHttpTxn`.  This is the case regardless of whether the
 continuation was added to the hook using :func:`TSHttpTxnHookAdd`, :func:`TSHttpSsnHookAdd`
-or :func:`TSHttpHookAdd`.
+or :func:`TSHttpHookAdd`.  If the event data is of type :type:`TSHttpTxn`, :type:`TSHttpSsn` or
+:type:`TSVConn`, the continuation function can assume the mutex of the indicated
+event data object is locked.  (But the continuation function must not unlock it.)
 
 Return Values
 =============