.\" Man page generated from reStructuredText.
.
.TH "TSCONTSCHEDULE" "3ts" "Dec 06, 2020" "8.0" "Apache Traffic Server"
.SH NAME
TSContSchedule \- TSContSchedule API function
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fI#include <ts/ts.h>\fP
.INDENT 0.0
.TP
.B TSAction TSContSchedule(TSCont\fI\ contp\fP, ink_hrtime\fI\ delay\fP, TSThreadPool\fI\ tp\fP)
.UNINDENT
.SH DESCRIPTION
.sp
Schedules \fIcontp\fP to run \fIdelay\fP milliseconds in the future. This is approximate. The delay
will be at least \fIdelay\fP but possibly more. Resolutions finer than roughly 5 milliseconds will
not be effective. \fIcontp\fP is required to have a mutex, which is provided to
\fBTSContCreate()\fP\&.
.sp
The return value can be used to cancel the scheduled event via \fBTSActionCancel()\fP\&. This is
effective until the continuation \fIcontp\fP is being dispatched. However, if it is scheduled on
another thread this can problematic to be correctly timed. The return value can be checked with
\fBTSActionDone()\fP to see if the continuation ran before the return, which is possible if
\fIdelay\fP is \fI0\fP\&.
.sp
The continuation is scheduled for a particular thread selected from a group of similar threads, as indicated by \fItp\fP\&.
.TS
center;
|l|l|.
_
T{
Pool
T}	T{
Properties
T}
_
T{
\fBTS_THREAD_POOL_DEFAULT\fP
T}	T{
Use the default pool. Continuations using this must not block.
T}
_
T{
\fBTS_THREAD_POOL_NET\fP
T}	T{
Transaction processing threads. Continuations on these threads must not block.
T}
_
T{
\fBTS_THREAD_POOL_TASK\fP
T}	T{
Background threads. Continuations can perform blocking operations.
T}
_
T{
\fBTS_THREAD_POOL_SSL\fP
T}	T{
\fIDEPRECATED\fP \- these are no longer used as of ATS 6.
T}
_
T{
\fBTS_THREAD_POOL_DNS\fP
T}	T{
DNS request processing. May not exist depending on configuration. Not recommended.
T}
_
T{
\fBTS_THREAD_POOL_REMAP\fP
T}	T{
\fIDEPRECATED\fP \- these are not longer used.
T}
_
T{
\fBTS_THREAD_POOL_CLUSTER\fP
T}	T{
\fIDEPRECATED\fP \- these are no longer used as of ATS 7.
T}
_
T{
\fBTS_THREAD_POOL_UDP\fP
T}	T{
\fIDEPRECATED\fP
T}
_
.TE
.sp
In practice, any choice except \fBTS_THREAD_POOL_NET\fP or \fBTS_THREAD_POOL_TASK\fP is strong not
recommended. The \fBTS_THREAD_POOL_NET\fP threads are the same threads on which callback hooks are
called and continuations that use them have the same restrictions. \fBTS_THREAD_POOL_TASK\fP threads
are threads that exist to perform long or blocking actions, although sufficiently long operation can
impact system performance by blocking other continuations on the threads.
.SH COPYRIGHT
2020, dev@trafficserver.apache.org
.\" Generated by docutils manpage writer.
.