All components of the SharpBCI pipeline are expected to implement this interface. More...

Inheritance diagram for SharpBCI.IPipeable:

Public Member Functions
void	SetInput (BlockingCollection< object > input)
	Set the input on this IPipeable to param input Should only be used internally by Connect. More...

void	Connect (IPipeable other, bool mirror)
	Connect the input of other to our output and allow for control of mirror data. More...

void	Connect (IPipeable other)
	Connect the input of other to our output Note: mirror == false using this override. More...

void	Start (TaskFactory taskFactory, CancellationTokenSource cts)
	Actually start doing work (i.e., promise to eventually start pushing data to connected pipeables) More...

void	Stop ()
	Require this IPipeable to stop, blocking until actually stopped. More...

Detailed Description

All components of the SharpBCI pipeline are expected to implement this interface.

See Also: Pipeable for an ABC which implement this in a performant and flexible manner.

Member Function Documentation

void SharpBCI.IPipeable.Connect	(	IPipeable	other,
		bool	mirror
	)

Connect the input of other to our output and allow for control of mirror data.

void SharpBCI.IPipeable.Connect ( IPipeable other )

Connect the input of other to our output Note: mirror == false using this override.

void SharpBCI.IPipeable.SetInput ( BlockingCollection< object > input )

Set the input on this IPipeable to param input Should only be used internally by Connect.

void SharpBCI.IPipeable.Start	(	TaskFactory	taskFactory,
		CancellationTokenSource	cts
	)

Actually start doing work (i.e., promise to eventually start pushing data to connected pipeables)

void SharpBCI.IPipeable.Stop ( )

Require this IPipeable to stop, blocking until actually stopped.

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