XmobiTea.Threading.PoolFiber Class Reference

Represents a pool of fibers that can enqueue tasks, schedule tasks, and schedule tasks at regular intervals. More...

Inheritance diagram for XmobiTea.Threading.PoolFiber:

Public Member Functions
	PoolFiber ()
	Initializes a new instance of the PoolFiber class.
IStatisticsCounter	GetEnqueueCounter ()
	Gets the counter for tracking enqueued tasks.
IStatisticsCounter	GetScheduleCounter ()
	Gets the counter for tracking scheduled tasks.
IStatisticsCounter	GetScheduleOnIntervalCounter ()
	Gets the counter for tracking tasks scheduled on intervals.
ISingleTask	Enqueue (Action action)
	Enqueues an action to be executed.
IScheduleTask	Schedule (Action action, long firstInMs)
	Schedules an action to be executed after a specified delay.
IScheduleOnIntervalTask	ScheduleOnInterval (Action action, long firstInMs, int regularInMs)
	Schedules an action to be executed at regular intervals.
void	Start ()
	Starts the fiber.
void	Dispose ()
	Disposes of the fiber, releasing any resources.
Public Member Functions inherited from XmobiTea.Threading.IEnqueue
Public Member Functions inherited from XmobiTea.Threading.ISchedule
Public Member Functions inherited from XmobiTea.Threading.IScheduleOnInterval
Public Member Functions inherited from XmobiTea.Threading.IFiberControl
Public Member Functions inherited from XmobiTea.Threading.IFiberStatisticsCounter

Detailed Description

Represents a pool of fibers that can enqueue tasks, schedule tasks, and schedule tasks at regular intervals.

Member Function Documentation

Dispose()

void XmobiTea.Threading.PoolFiber.Dispose

(

)

Disposes of the fiber, releasing any resources.

Implements XmobiTea.Threading.IFiberControl.

Enqueue()

ISingleTask XmobiTea.Threading.PoolFiber.Enqueue

(

Action

action

)

Enqueues an action to be executed.

Parameters

action

The action to be enqueued.

Returns

An instance of ISingleTask representing the enqueued task.

Implements XmobiTea.Threading.IEnqueue.

GetEnqueueCounter()

IStatisticsCounter XmobiTea.Threading.PoolFiber.GetEnqueueCounter

(

)

Gets the counter for tracking enqueued tasks.

Returns

An instance of IStatisticsCounter for enqueued tasks.

Implements XmobiTea.Threading.IFiberStatisticsCounter.

GetScheduleCounter()

IStatisticsCounter XmobiTea.Threading.PoolFiber.GetScheduleCounter

(

)

Gets the counter for tracking scheduled tasks.

Returns

An instance of IStatisticsCounter for scheduled tasks.

Implements XmobiTea.Threading.IFiberStatisticsCounter.

GetScheduleOnIntervalCounter()

IStatisticsCounter XmobiTea.Threading.PoolFiber.GetScheduleOnIntervalCounter

(

)

Gets the counter for tracking tasks scheduled on intervals.

Returns

An instance of IStatisticsCounter for interval scheduled tasks.

Implements XmobiTea.Threading.IFiberStatisticsCounter.

Schedule()

IScheduleTask XmobiTea.Threading.PoolFiber.Schedule	(	Action	action,
		long	firstInMs )

Schedules an action to be executed after a specified delay.

Parameters

action	The action to be scheduled.
firstInMs	The delay in milliseconds before the action is executed.

Returns

An instance of IScheduleTask representing the scheduled task.

Implements XmobiTea.Threading.ISchedule.

ScheduleOnInterval()

IScheduleOnIntervalTask XmobiTea.Threading.PoolFiber.ScheduleOnInterval	(	Action	action,
		long	firstInMs,
		int	regularInMs )

Schedules an action to be executed at regular intervals.

Parameters

action	The action to be scheduled.
firstInMs	The delay in milliseconds before the first execution of the action.
regularInMs	The interval in milliseconds between subsequent executions of the action.

Returns

An instance of IScheduleOnIntervalTask representing the scheduled task.

Implements XmobiTea.Threading.IScheduleOnInterval.

Start()

void XmobiTea.Threading.PoolFiber.Start

(

)

Starts the fiber.

Implements XmobiTea.Threading.IFiberControl.

---

The documentation for this class was generated from the following file:

• XmobiTea.Threading/PoolFiber.cs