Skip to content

Make plugin API cleanup functions noexcept #13590

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

Open
bryancall wants to merge 2 commits into
base: master
Choose a base branch
from
+217 −137
Open

Make plugin API cleanup functions noexcept #13590

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a258c23
Make plugin API cleanup functions noexcept
bryancall Aug 26, 2026
e7c7801
Merge remote-tracking branch 'origin/master' into coverity-noexcept-p…
bryancall Aug 27, 2026
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
2 changes: 1 addition & 1 deletion doc/developer-guide/api/functions/TSActionCancel.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Synopsis

#include <ts/ts.h>

.. function:: void TSActionCancel(TSAction actionp)
.. function:: void TSActionCancel(TSAction actionp) noexcept

Description
===========
Expand Down
2 changes: 1 addition & 1 deletion doc/developer-guide/api/functions/TSContDataGet.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Synopsis

#include <ts/ts.h>

.. function:: void* TSContDataGet(TSCont contp)
.. function:: void* TSContDataGet(TSCont contp) noexcept

Description
===========
2 changes: 1 addition & 1 deletion doc/developer-guide/api/functions/TSContDataSet.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Synopsis

#include <ts/ts.h>

.. function:: void TSContDataSet(TSCont contp, void * data)
.. function:: void TSContDataSet(TSCont contp, void * data) noexcept

Description
===========
2 changes: 1 addition & 1 deletion doc/developer-guide/api/functions/TSContDestroy.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Synopsis

#include <ts/ts.h>

.. function:: void TSContDestroy(TSCont contp)
.. function:: void TSContDestroy(TSCont contp) noexcept

Description
===========
2 changes: 1 addition & 1 deletion doc/developer-guide/api/functions/TSDebug.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Synopsis
.. function:: void TSStatus(const char * format, ...)
.. function:: void TSNote(const char * format, ...)
.. function:: void TSWarning(const char * format, ...)
.. function:: void TSError(const char * format, ...)
.. function:: void TSError(const char * format, ...) noexcept
.. function:: void TSFatal(const char * format, ...)
.. function:: void TSAlert(const char * format, ...)
.. function:: void TSEmergency(const char * format, ...)
Expand Down
2 changes: 1 addition & 1 deletion doc/developer-guide/api/functions/TSFetchCreate.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Synopsis
.. function:: void TSFetchWriteData(TSFetchSM, const void *, size_t)
.. function:: ssize_t TSFetchReadData(TSFetchSM, void *, size_t)
.. function:: void TSFetchLaunch(TSFetchSM)
.. function:: void TSFetchDestroy(TSFetchSM)
.. function:: void TSFetchDestroy(TSFetchSM) noexcept
.. function:: void TSFetchUserDataSet(TSFetchSM, void *)
.. function:: void* TSFetchUserDataGet(TSFetchSM)
.. function:: TSMBuffer TSFetchRespHdrMBufGet(TSFetchSM)
Expand Down
2 changes: 1 addition & 1 deletion doc/developer-guide/api/functions/TSHttpHdrDestroy.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Synopsis

#include <ts/ts.h>

.. function:: void TSHttpHdrDestroy(TSMBuffer bufp, TSMLoc offset)
.. function:: void TSHttpHdrDestroy(TSMBuffer bufp, TSMLoc offset) noexcept

Description
===========
Expand Down
2 changes: 1 addition & 1 deletion doc/developer-guide/api/functions/TSHttpParserCreate.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Synopsis

.. function:: TSHttpParser TSHttpParserCreate(void)
.. function:: void TSHttpParserClear(TSHttpParser parser)
.. function:: void TSHttpParserDestroy(TSHttpParser parser)
.. function:: void TSHttpParserDestroy(TSHttpParser parser) noexcept
.. function:: TSParseResult TSHttpHdrParseReq(TSHttpParser parser, TSMBuffer bufp, TSMLoc offset, const char ** start, const char * end)
.. function:: TSParseResult TSHttpHdrParseResp(TSHttpParser parser, TSMBuffer bufp, TSMLoc offset, const char ** start, const char * end)

Expand Down
2 changes: 1 addition & 1 deletion doc/developer-guide/api/functions/TSIOBufferCreate.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Synopsis

.. function:: TSIOBuffer TSIOBufferCreate(void)
.. function:: TSIOBuffer TSIOBufferSizedCreate(TSIOBufferSizeIndex index)
.. function:: void TSIOBufferDestroy(TSIOBuffer bufp)
.. function:: void TSIOBufferDestroy(TSIOBuffer bufp) noexcept
.. function:: int64_t TSIOBufferWrite(TSIOBuffer bufp, const void * buf, int64_t length)
.. function:: void TSIOBufferProduce(TSIOBuffer bufp, int64_t nbytes)
.. function:: int64_t TSIOBufferWaterMarkGet(TSIOBuffer bufp)
Expand Down
6 changes: 3 additions & 3 deletions doc/developer-guide/api/functions/TSIOBufferReader.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@ Synopsis

.. function:: TSIOBufferReader TSIOBufferReaderAlloc(TSIOBuffer bufp)
.. function:: TSIOBufferReader TSIOBufferReaderClone(TSIOBufferReader readerp)
.. function:: void TSIOBufferReaderFree(TSIOBufferReader readerp)
.. function:: void TSIOBufferReaderConsume(TSIOBufferReader readerp, int64_t nbytes)
.. function:: void TSIOBufferReaderFree(TSIOBufferReader readerp) noexcept
.. function:: void TSIOBufferReaderConsume(TSIOBufferReader readerp, int64_t nbytes) noexcept
.. function:: TSIOBufferBlock TSIOBufferReaderStart(TSIOBufferReader readerp)
.. function:: int64_t TSIOBufferReaderAvail(TSIOBufferReader readerp)
.. function:: int64_t TSIOBufferReaderAvail(TSIOBufferReader readerp) noexcept
.. function:: int64_t TSIOBufferReaderCopy(TSIOBufferReader reader, void * buf, int64_t length)

Description
Expand Down
4 changes: 2 additions & 2 deletions doc/developer-guide/api/functions/TSMBufferCreate.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ Synopsis
#include <ts/ts.h>

.. function:: TSMBuffer TSMBufferCreate(void)
.. function:: TSReturnCode TSMBufferDestroy(TSMBuffer bufp)
.. function:: TSReturnCode TSHandleMLocRelease(TSMBuffer bufp, TSMLoc parent, TSMLoc mloc)
.. function:: TSReturnCode TSMBufferDestroy(TSMBuffer bufp) noexcept
.. function:: TSReturnCode TSHandleMLocRelease(TSMBuffer bufp, TSMLoc parent, TSMLoc mloc) noexcept

Description
===========
Expand Down
2 changes: 1 addition & 1 deletion doc/developer-guide/api/functions/TSMimeHdrDestroy.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Synopsis

#include <ts/ts.h>

.. function:: TSReturnCode TSMimeHdrDestroy(TSMBuffer bufp, TSMLoc offset)
.. function:: TSReturnCode TSMimeHdrDestroy(TSMBuffer bufp, TSMLoc offset) noexcept

Description
===========
Expand Down
2 changes: 1 addition & 1 deletion doc/developer-guide/api/functions/TSMutexDestroy.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Synopsis

#include <ts/ts.h>

.. function:: void TSMutexDestroy(TSMutex mutexp)
.. function:: void TSMutexDestroy(TSMutex mutexp) noexcept

Description
===========
Expand Down
2 changes: 1 addition & 1 deletion doc/developer-guide/api/functions/TSMutexLock.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Synopsis

#include <ts/ts.h>

.. function:: void TSMutexLock(TSMutex mutexp)
.. function:: void TSMutexLock(TSMutex mutexp) noexcept

Description
===========
Expand Down
2 changes: 1 addition & 1 deletion doc/developer-guide/api/functions/TSMutexLockTry.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Synopsis

#include <ts/ts.h>

.. function:: TSReturnCode TSMutexLockTry(TSMutex mutexp)
.. function:: TSReturnCode TSMutexLockTry(TSMutex mutexp) noexcept

Description
===========
2 changes: 1 addition & 1 deletion doc/developer-guide/api/functions/TSMutexUnlock.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Synopsis

#include <ts/ts.h>

.. function:: void TSMutexUnlock(TSMutex mutexp)
.. function:: void TSMutexUnlock(TSMutex mutexp) noexcept

Description
===========
Expand Down
2 changes: 1 addition & 1 deletion doc/developer-guide/api/functions/TSSslServerContextCreate.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Synopsis
#include <ts/ts.h>

.. function:: TSSslContext TSSslServerContextCreate(TSSslX509 *cert, char *certname)
.. function:: void TSSslContextDestroy(TSSslContext ctx)
.. function:: void TSSslContextDestroy(TSSslContext ctx) noexcept

Description
===========
Expand Down
4 changes: 2 additions & 2 deletions doc/developer-guide/api/functions/TSTextLogObjectCreate.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ Synopsis

.. function:: TSReturnCode TSTextLogObjectCreate(const char * filename, int mode, TSTextLogObject * new_log_obj)
.. function:: TSReturnCode TSTextLogObjectWrite(TSTextLogObject the_object, const char * format, ...)
.. function:: void TSTextLogObjectFlush(TSTextLogObject the_object)
.. function:: TSReturnCode TSTextLogObjectDestroy(TSTextLogObject the_object)
.. function:: void TSTextLogObjectFlush(TSTextLogObject the_object) noexcept
.. function:: TSReturnCode TSTextLogObjectDestroy(TSTextLogObject the_object) noexcept
.. function:: void TSTextLogObjectHeaderSet(TSTextLogObject the_object, const char * header)
.. function:: TSReturnCode TSTextLogObjectRollingEnabledSet(TSTextLogObject the_object, int rolling_enabled)
.. function:: void TSTextLogObjectRollingIntervalSecSet(TSTextLogObject the_object, int rolling_interval_sec)
Expand Down
2 changes: 1 addition & 1 deletion doc/developer-guide/api/functions/TSThreadDestroy.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Synopsis

#include <ts/ts.h>

.. function:: void TSThreadDestroy(TSThread thread)
.. function:: void TSThreadDestroy(TSThread thread) noexcept

Description
===========
2 changes: 1 addition & 1 deletion doc/developer-guide/api/functions/TSVConnAbort.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Synopsis

#include <ts/ts.h>

.. function:: void TSVConnAbort(TSVConn connp, int error)
.. function:: void TSVConnAbort(TSVConn connp, int error) noexcept

Description
===========
2 changes: 1 addition & 1 deletion doc/developer-guide/api/functions/TSVConnClose.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Synopsis

#include <ts/ts.h>

.. function:: void TSVConnClose(TSVConn connp)
.. function:: void TSVConnClose(TSVConn connp) noexcept

Description
===========
2 changes: 1 addition & 1 deletion doc/developer-guide/api/functions/TSVConnShutdown.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Synopsis

#include <ts/ts.h>

.. function:: void TSVConnShutdown(TSVConn connp, int read, int write)
.. function:: void TSVConnShutdown(TSVConn connp, int read, int write) noexcept

Description
===========
12 changes: 11 additions & 1 deletion doc/developer-guide/plugins/getting-started/index.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,17 @@ Getting Started
The Traffic Server API enables you to create plugins, using the C++
programming language, that customize the behavior of your Traffic Server
installation. (Your plugin may not work properly if you use a version of C++
older than C++17.) This chapter contains the following sections:
older than C++17.)

C++ exceptions are not a supported error channel across the plugin API. API
functions report failure through their return values, and a plugin must not
allow one of its own exceptions to propagate into Traffic Server (for example
out of a continuation handler). API functions that plugins commonly call
during cleanup are declared ``noexcept``; if an internal error would otherwise
escape such a call as an exception, Traffic Server aborts with a message
naming the function rather than raising an exception in the plugin.

This chapter contains the following sections:

- `Understanding Traffic Server Plugins`_ -- a brief introduction to plugins.

Expand Down
Loading