TimerTask.Start Method

Solclient

TimerTaskStart Method

version: 7.2.1.27

Factory method of TimerTasks. A TimerTask allows applications to execute a user-defined delegate in the context of a given IContext thread. The timer duration is subject to the timer resolution specified by the context property 'TimerResolutionInMsecs', up to the nearest timer resolution interval. For example, if the context timer resolution is 50 ms, and a timer is started with a duration of 60 ms, then the timer duration is rounded up to 100 ms (2 ticks), and then one further tick is added for a total timer duration of 150 ms. This extra tick accounts for the fact that the current tick might be just about to advance when the timer is started. Thus, the actual timeout in this example is approximately in the range of 100 ms to 150 ms.

The timer callback delegate is invoked in the context of the context thread. The timer durations are approximate; the actual duration can be affected by the processing time spent in other callbacks by the context thread, such as for session or flowEvent events and received messages.

Note: disposing the corresponding context (IContext) or any of its contained context timers (TimerTask), sessions (ISession) or flows (IFlow) must not be performed from within the registered userCallbackDelegate.

This timer service should only be used for applications that require a coarse timer service (for example, a guard timer, or other timer uses that do not require a highly accurate timer service).

When a one-shot timer expires, the timer is automatically cancelled. When a repeat timer expires, the timer is automatically rescheduled for the same duration, and continues to run until stopped using Dispose.

Note that the invoked timer callback delegate routine is allowed to start and stop timers.

Namespace: SolaceSystems.Solclient.Messaging
Assembly: SolaceSystems.Solclient.Messaging (in SolaceSystems.Solclient.Messaging.dll) Version: 7.2.1.27 (7.2.1.27)

Syntax

C++

Copy

public static TimerTask Start(
	IContext context,
	TimerCallback userCallbackDelegate,
	TimerMode timerMode,
	long durationInMsecs,
	Object userState
)

Public Shared Function Start ( 
	context As IContext,
	userCallbackDelegate As TimerCallback,
	timerMode As TimerMode,
	durationInMsecs As Long,
	userState As Object
) As TimerTask

public:
static TimerTask^ Start(
	IContext^ context, 
	TimerCallback^ userCallbackDelegate, 
	TimerMode timerMode, 
	long long durationInMsecs, 
	Object^ userState
)

Parameters

context: Type: SolaceSystems.Solclient.MessagingIContext
The IContext to schedule the timer on
userCallbackDelegate: Type: System.ThreadingTimerCallback
The user callback delegate to call when the timer expires. The call occurs over the IContext thread
timerMode: Type: SolaceSystems.Solclient.MessagingTimerMode
Use OneShot to create a one shot timer, Repeat otherwise
durationInMsecs: Type: SystemInt64
The timer interval in milliseconds. This is subject to the specified timer resolution see Start(IContext, TimerCallback, TimerMode, Int64, Object) for more details
userState: Type: SystemObject
An object reference that's passed to the userCallbackDelegate when the timer expires, can be null

Return Value

Type: TimerTask
Returns a TimerTask

Reference

TimerTask Class

SolaceSystems.Solclient.Messaging Namespace

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to use and copy the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

UNLESS STATED ELSEWHERE BETWEEN YOU AND SOLACE SYSTEMS, INC., THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Send comments on this topic to [email protected]

previous page start next page