SpicyPixel.Threading.FiberFactory Class Reference

A Fiber Factory for creating fibers with the same options. More...

Collaboration diagram for SpicyPixel.Threading.FiberFactory:

Public Member Functions
	FiberFactory ()
	Initializes a new instance of the SpicyPixel.Threading.FiberFactory class. More...
	FiberFactory (CancellationToken cancellationToken)
	Initializes a new instance of the SpicyPixel.Threading.FiberFactory class. More...
	FiberFactory (FiberScheduler scheduler)
	Initializes a new instance of the SpicyPixel.Threading.FiberFactory class. More...
	FiberFactory (FiberContinuationOptions continuationOptions)
	Initializes a new instance of the SpicyPixel.Threading.FiberFactory class. More...
	FiberFactory (CancellationToken cancellationToken, FiberContinuationOptions continuationOptions, FiberScheduler scheduler)
	Initializes a new instance of the SpicyPixel.Threading.FiberFactory class. More...
Fiber	StartNew (IEnumerator coroutine)
	Start executing a new fiber using the default scheduler on the thread. More...
Fiber	StartNew (IEnumerator coroutine, CancellationToken cancellationToken)
	Start executing a new fiber using the default scheduler on the thread. More...
Fiber	StartNew (IEnumerator coroutine, FiberScheduler scheduler)
	Start executing a new fiber using the specified scheduler. More...
Fiber	StartNew (IEnumerator coroutine, CancellationToken cancellationToken, FiberScheduler scheduler)
	Start executing a new fiber using the specified scheduler. More...
Fiber	StartNew (Action action)
	Start executing a new fiber using the default scheduler on the thread. More...
Fiber	StartNew (Action action, CancellationToken cancellationToken)
	Start executing a new fiber using the default scheduler on the thread. More...
Fiber	StartNew (Action action, FiberScheduler scheduler)
	Start executing a new fiber using the default scheduler on the thread. More...
Fiber	StartNew (Action action, CancellationToken cancellationToken, FiberScheduler scheduler)
	Start executing a new fiber using the default scheduler on the thread. More...
Fiber	StartNew (Action< object > action, object state)
	Start executing a new fiber using the default scheduler on the thread. More...
Fiber	StartNew (Action< object > action, object state, CancellationToken cancellationToken)
	Start executing a new fiber using the default scheduler on the thread. More...
Fiber	StartNew (Action< object > action, object state, FiberScheduler scheduler)
	Start executing a new fiber using the default scheduler on the thread. More...
Fiber	StartNew (Action< object > action, object state, CancellationToken cancellationToken, FiberScheduler scheduler)
	Start executing a new fiber using the default scheduler on the thread. More...
Fiber	StartNew (Func< FiberInstruction > func)
	Initializes a new instance of the SpicyPixel.Threading.Fiber class. More...
Fiber	StartNew (Func< FiberInstruction > func, CancellationToken cancellationToken)
	Initializes a new instance of the SpicyPixel.Threading.Fiber class. More...
Fiber	StartNew (Func< FiberInstruction > func, FiberScheduler scheduler)
	Initializes a new instance of the SpicyPixel.Threading.Fiber class. More...
Fiber	StartNew (Func< FiberInstruction > func, CancellationToken cancellationToken, FiberScheduler scheduler)
	Initializes a new instance of the SpicyPixel.Threading.Fiber class. More...
Fiber	StartNew (Func< object, FiberInstruction > func, object state)
	Initializes a new instance of the SpicyPixel.Threading.Fiber class. More...
Fiber	StartNew (Func< object, FiberInstruction > func, object state, CancellationToken cancellationToken)
	Initializes a new instance of the SpicyPixel.Threading.Fiber class. More...
Fiber	StartNew (Func< object, FiberInstruction > func, object state, FiberScheduler scheduler)
	Initializes a new instance of the SpicyPixel.Threading.Fiber class. More...
Fiber	StartNew (Func< object, FiberInstruction > func, object state, CancellationToken cancellationToken, FiberScheduler scheduler)
	Initializes a new instance of the SpicyPixel.Threading.Fiber class. More...

Properties
FiberScheduler	Scheduler [get]
	Gets the scheduler. More...
FiberContinuationOptions	ContinuationOptions [get]
	Gets the continuation options. More...
CancellationToken	CancellationToken [get]
	Gets the cancellation token. More...

Detailed Description

A Fiber Factory for creating fibers with the same options.

Definition at line 9 of file FiberFactory.cs.

Constructor & Destructor Documentation

SpicyPixel.Threading.FiberFactory.FiberFactory

(

)

Initializes a new instance of the SpicyPixel.Threading.FiberFactory class.

Definition at line 18 of file FiberFactory.cs.

SpicyPixel.Threading.FiberFactory.FiberFactory

(

CancellationToken

cancellationToken

)

Initializes a new instance of the SpicyPixel.Threading.FiberFactory class.

Parameters

cancellationToken

Cancellation token.

Definition at line 27 of file FiberFactory.cs.

SpicyPixel.Threading.FiberFactory.FiberFactory

(

FiberScheduler

scheduler

)

Initializes a new instance of the SpicyPixel.Threading.FiberFactory class.

Parameters

scheduler

Scheduler.

Definition at line 36 of file FiberFactory.cs.

SpicyPixel.Threading.FiberFactory.FiberFactory

(

FiberContinuationOptions

continuationOptions

)

Initializes a new instance of the SpicyPixel.Threading.FiberFactory class.

Parameters

continuationOptions

Continuation options.

Definition at line 45 of file FiberFactory.cs.

SpicyPixel.Threading.FiberFactory.FiberFactory	(	CancellationToken	cancellationToken,
		FiberContinuationOptions	continuationOptions,
		FiberScheduler	scheduler
	)

Initializes a new instance of the SpicyPixel.Threading.FiberFactory class.

Parameters

cancellationToken	Cancellation token.
continuationOptions	Continuation options.
scheduler	Scheduler.

Definition at line 56 of file FiberFactory.cs.

Member Function Documentation

Fiber SpicyPixel.Threading.FiberFactory.StartNew

(

IEnumerator

coroutine

)

Start executing a new fiber using the default scheduler on the thread.

Returns

Returns a Fiber that can be yielded against to wait for the fiber to complete.

Parameters

coroutine

A couroutine to execute on the fiber.

Definition at line 19 of file FiberFactory.StartNew.cs.

Fiber SpicyPixel.Threading.FiberFactory.StartNew	(	IEnumerator	coroutine,
		CancellationToken	cancellationToken
	)

Start executing a new fiber using the default scheduler on the thread.

Returns

Returns a Fiber that can be yielded against to wait for the fiber to complete.

Parameters

coroutine	A couroutine to execute on the fiber.
cancellationToken	Cancellation token.

Definition at line 35 of file FiberFactory.StartNew.cs.

Fiber SpicyPixel.Threading.FiberFactory.StartNew	(	IEnumerator	coroutine,
		FiberScheduler	scheduler
	)

Start executing a new fiber using the specified scheduler.

Returns

Returns a Fiber that can be yielded against to wait for the fiber to complete.

Parameters

coroutine	A couroutine to execute on the fiber.
scheduler	A scheduler to execute the fiber on.

Definition at line 53 of file FiberFactory.StartNew.cs.

Fiber SpicyPixel.Threading.FiberFactory.StartNew	(	IEnumerator	coroutine,
		CancellationToken	cancellationToken,
		FiberScheduler	scheduler
	)

Start executing a new fiber using the specified scheduler.

Returns

Returns a Fiber that can be yielded against to wait for the fiber to complete.

Parameters

coroutine	A couroutine to execute on the fiber.
cancellationToken	Cancellation token.
scheduler	A scheduler to execute the fiber on.

Definition at line 72 of file FiberFactory.StartNew.cs.

Fiber SpicyPixel.Threading.FiberFactory.StartNew

(

Action

action

)

Start executing a new fiber using the default scheduler on the thread.

Returns

Returns a Fiber that can be yielded against to wait for the fiber to complete.

Parameters

action

A non-blocking action to execute on the fiber.

Definition at line 89 of file FiberFactory.StartNew.cs.

Fiber SpicyPixel.Threading.FiberFactory.StartNew	(	Action	action,
		CancellationToken	cancellationToken
	)

Start executing a new fiber using the default scheduler on the thread.

Returns

Returns a Fiber that can be yielded against to wait for the fiber to complete.

Parameters

action	A non-blocking action to execute on the fiber.
cancellationToken	Cancellation token.

Definition at line 105 of file FiberFactory.StartNew.cs.

Fiber SpicyPixel.Threading.FiberFactory.StartNew	(	Action	action,
		FiberScheduler	scheduler
	)

Start executing a new fiber using the default scheduler on the thread.

Returns

Returns a Fiber that can be yielded against to wait for the fiber to complete.

Parameters

action	A non-blocking action to execute on the fiber.
scheduler	A scheduler to execute the fiber on.

Definition at line 123 of file FiberFactory.StartNew.cs.

Fiber SpicyPixel.Threading.FiberFactory.StartNew	(	Action	action,
		CancellationToken	cancellationToken,
		FiberScheduler	scheduler
	)

Start executing a new fiber using the default scheduler on the thread.

Returns

Returns a Fiber that can be yielded against to wait for the fiber to complete.

Parameters

action	A non-blocking action to execute on the fiber.
cancellationToken	Cancellation token.
scheduler	A scheduler to execute the fiber on.

Definition at line 142 of file FiberFactory.StartNew.cs.

Fiber SpicyPixel.Threading.FiberFactory.StartNew	(	Action< object >	action,
		object	state
	)

Start executing a new fiber using the default scheduler on the thread.

Returns

Returns a Fiber that can be yielded against to wait for the fiber to complete.

Parameters

action	A non-blocking action to execute on the fiber.
state	State to pass to the action.

Definition at line 162 of file FiberFactory.StartNew.cs.

Fiber SpicyPixel.Threading.FiberFactory.StartNew	(	Action< object >	action,
		object	state,
		CancellationToken	cancellationToken
	)

Start executing a new fiber using the default scheduler on the thread.

Returns

Returns a Fiber that can be yielded against to wait for the fiber to complete.

Parameters

action	A non-blocking action to execute on the fiber.
state	State to pass to the action.
cancellationToken	Cancellation token.

Definition at line 181 of file FiberFactory.StartNew.cs.

Fiber SpicyPixel.Threading.FiberFactory.StartNew	(	Action< object >	action,
		object	state,
		FiberScheduler	scheduler
	)

Start executing a new fiber using the default scheduler on the thread.

Returns

Returns a Fiber that can be yielded against to wait for the fiber to complete.

Parameters

action	A non-blocking action to execute on the fiber.
state	State to pass to the action.
scheduler	A scheduler to execute the fiber on.

Definition at line 202 of file FiberFactory.StartNew.cs.

Fiber SpicyPixel.Threading.FiberFactory.StartNew	(	Action< object >	action,
		object	state,
		CancellationToken	cancellationToken,
		FiberScheduler	scheduler
	)

Start executing a new fiber using the default scheduler on the thread.

Returns

Returns a Fiber that can be yielded against to wait for the fiber to complete.

Parameters

action	A non-blocking action to execute on the fiber.
state	State to pass to the action.
cancellationToken	Cancellation token.
scheduler	A scheduler to execute the fiber on.

Definition at line 224 of file FiberFactory.StartNew.cs.

Fiber SpicyPixel.Threading.FiberFactory.StartNew

(

Func< FiberInstruction >

func

)

Initializes a new instance of the SpicyPixel.Threading.Fiber class.

Parameters

func	A non-blocking function that returns a Fiber when complete.

Definition at line 237 of file FiberFactory.StartNew.cs.

Fiber SpicyPixel.Threading.FiberFactory.StartNew	(	Func< FiberInstruction >	func,
		CancellationToken	cancellationToken
	)

Initializes a new instance of the SpicyPixel.Threading.Fiber class.

Parameters

func	A non-blocking function that returns a Fiber when complete.
cancellationToken	Cancellation token.

Definition at line 249 of file FiberFactory.StartNew.cs.

Fiber SpicyPixel.Threading.FiberFactory.StartNew	(	Func< FiberInstruction >	func,
		FiberScheduler	scheduler
	)

Initializes a new instance of the SpicyPixel.Threading.Fiber class.

Parameters

func	A non-blocking function that returns a Fiber when complete.
scheduler	A scheduler to execute the fiber on.

Definition at line 263 of file FiberFactory.StartNew.cs.

Fiber SpicyPixel.Threading.FiberFactory.StartNew	(	Func< FiberInstruction >	func,
		CancellationToken	cancellationToken,
		FiberScheduler	scheduler
	)

Initializes a new instance of the SpicyPixel.Threading.Fiber class.

Parameters

func	A non-blocking function that returns a Fiber when complete.
cancellationToken	Cancellation token.
scheduler	A scheduler to execute the fiber on.

Definition at line 278 of file FiberFactory.StartNew.cs.

Fiber SpicyPixel.Threading.FiberFactory.StartNew	(	Func< object, FiberInstruction >	func,
		object	state
	)

Initializes a new instance of the SpicyPixel.Threading.Fiber class.

Parameters

func	A non-blocking function that returns a Fiber when complete.
state	State to pass to the function.

Definition at line 294 of file FiberFactory.StartNew.cs.

Fiber SpicyPixel.Threading.FiberFactory.StartNew	(	Func< object, FiberInstruction >	func,
		object	state,
		CancellationToken	cancellationToken
	)

Initializes a new instance of the SpicyPixel.Threading.Fiber class.

Parameters

func	A non-blocking function that returns a Fiber when complete.
state	State to pass to the function.
cancellationToken	Cancellation token.

Definition at line 309 of file FiberFactory.StartNew.cs.

Fiber SpicyPixel.Threading.FiberFactory.StartNew	(	Func< object, FiberInstruction >	func,
		object	state,
		FiberScheduler	scheduler
	)

Initializes a new instance of the SpicyPixel.Threading.Fiber class.

Parameters

func	A non-blocking function that returns a Fiber when complete.
state	State to pass to the function.
scheduler	A scheduler to execute the fiber on.

Definition at line 326 of file FiberFactory.StartNew.cs.

Fiber SpicyPixel.Threading.FiberFactory.StartNew	(	Func< object, FiberInstruction >	func,
		object	state,
		CancellationToken	cancellationToken,
		FiberScheduler	scheduler
	)

Initializes a new instance of the SpicyPixel.Threading.Fiber class.

Parameters

func	A non-blocking function that returns a Fiber when complete.
state	State to pass to the function.
cancellationToken	Cancellation token.
scheduler	A scheduler to execute the fiber on.

Definition at line 344 of file FiberFactory.StartNew.cs.

Property Documentation

CancellationToken SpicyPixel.Threading.FiberFactory.CancellationToken

get

Gets the cancellation token.

The cancellation token.

Definition at line 96 of file FiberFactory.cs.

FiberContinuationOptions SpicyPixel.Threading.FiberFactory.ContinuationOptions

get

Gets the continuation options.

The continuation options.

Definition at line 86 of file FiberFactory.cs.

FiberScheduler SpicyPixel.Threading.FiberFactory.Scheduler

get

Gets the scheduler.

The scheduler.

Definition at line 76 of file FiberFactory.cs.

---

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

• FiberFactory.cs
• FiberFactory.StartNew.cs