Skip to content

Add more information about event data to 'hook add' API function documentation. #4749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SolidWallOfCode merged 1 commit into from
Jan 22, 2019
Merged

Add more information about event data to 'hook add' API function documentation. #4749

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions doc/developer-guide/api/functions/TSHttpHookAdd.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
=============
Expand Down