duke8253 commented on code in PR #10742: URL: https://github.com/apache/trafficserver/pull/10742#discussion_r1389995984
########## doc/developer-guide/api/functions/TSContScheduleEveryOnEntirePool.en.rst: ########## @@ -0,0 +1,60 @@ +.. Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed + with this work for additional information regarding copyright + ownership. The ASF licenses this file to you under the Apache + License, Version 2.0 (the "License"); you may not use this file + except in compliance with the License. You may obtain a copy of + the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied. See the License for the specific language governing + permissions and limitations under the License. + +.. include:: ../../../common.defs + +.. default-domain:: c + +TSContScheduleEveryOnEntirePool +******************************* + +Synopsis +======== + +.. code-block:: cpp + + #include <ts/ts.h> + +.. function:: std::vector<TSAction> TSContScheduleEveryOnEntirePool(TSCont contp, TSHRTime every, TSThreadPool tp) + +Description +=========== + +Schedules :arg:`contp` to run :arg:`every` milliseconds, on all threads that +belongs to :arg:`tp`. The :arg:`every` is an approximation, meaning it will be at least +:arg:`every` milliseconds but possibly more. Resolutions finer than roughly 5 milliseconds will +not be effective. Note that :arg:`contp` is required to NOT have a mutex, since the continuation +is scheduled on multiple threads. This means the continuation must handle synchronization itself. + +The return value can be used to cancel the scheduled event via :func:`TSActionCancel`. This +is effective until the continuation :arg:`contp` 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 :func:`TSActionDone` to see if the continuation ran before the return, +which is possible if :arg:`timeout` is `0`. Review Comment: Yeah, I copied some of the text from the other docs , `every == 0` is not allowed for any of the `TSContScheduleEveryXXX` calls. I'll fix this. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
