.\" Man page generated from reStructuredText.
.
.
.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
..
.TH "TSCONTSCHEDULE" "3ts" "Jan 06, 2024" "9.2" "Apache Traffic Server"
.SH NAME
TSContSchedule \- TSContSchedule API function
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
#include <ts/ts.h>
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \fI\%TSAction\fP TSContSchedule(\fI\%TSCont\fP contp, \fI\%TSHRTime\fP timeout) 
.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
\fI\%TSContCreate()\fP\&.
.sp
The return value can be used to cancel the scheduled event via \fI\%TSActionCancel()\fP\&. This is
effective until the continuation \fIcontp\fP is being dispatched. However, if it is scheduled on
another thread this can be problematic to be correctly timed. The return value can be checked with
\fI\%TSActionDone()\fP to see if the continuation ran before the return, which is possible if
\fItimeout\fP is \fI0\fP\&. Returns \fBnullptr\fP if thread affinity was cleared.
.sp
TSContSchedule() or TSContScheduleEvery() will default to set the thread affinity to the calling thread
when no affinity is already set for example, using \fI\%TSContThreadAffinitySet()\fP
.sp
Note that the TSContSchedule() family of API shall only be called from an ATS EThread.
Calling it from raw non\-EThreads can result in unpredictable behavior.
.SH SEE ALSO
.sp
\fI\%TSContScheduleEvery\fP
\fI\%TSContScheduleOnPool\fP
\fI\%TSContScheduleOnThread\fP
.SH COPYRIGHT
2024, dev@trafficserver.apache.org
.\" Generated by docutils manpage writer.
.