INTELLI::HandShakeWS Class Reference

The eager window slider of handshake join. More...

#include <WindowSlider/HandShakeWS.h>

Inheritance diagram for INTELLI::HandShakeWS:

Collaboration diagram for INTELLI::HandShakeWS:

Public Member Functions
	HandShakeWS (size_t sLen, size_t rLen)
void	initJoinProcessors ()
	to init the initJoinProcessors More...
void	terminateJoinProcessors ()
	to terminate the join processors
void	waitAckFromJoinProcessors ()
	to wait the response of join processors
size_t	getJoinResult ()
	to get the result of join More...
void	feedTupleS (TuplePtr ts)
	to feed a tuple s More...
void	feedTupleR (TuplePtr tr)
	to feed a tuple R More...
Public Member Functions inherited from INTELLI::AbstractWS
void	setTimeBased (bool ts)
	to configure the window type More...
bool	isTimeBased ()
	to read the window type More...
void	setRunTimeScheduling (bool r)
	to configure the scheduling place More...
bool	isRunTimeScheduling ()
	to read the scheduling type More...
void	setWindowLen (size_t wl)
	to set the length of window More...
void	setSlideLen (size_t sli)
	set the length of slide More...
size_t	getSlideLen ()
	get the length of slide More...
void	setParallelSMP (size_t threads)
	to set the parallel level under SMP model More...
void	reset ()
	reset everything needed
size_t	getTimeStamp ()
	to get the time stamp More...
	AbstractWS (size_t sLen, size_t rLen)
	to init the slider with specific length of queue More...
struct timeval	getSysTime ()
	to get the inline timee structure, the timeSys member More...
void	setSysTime (struct timeval tv)
	Set the time structure value ,the timeSys member. More...
string	getName ()
	get the name of the slider More...

Protected Attributes
std::vector< HandShakeJPPtr >	jpPtr
INTELLI::BarrierPtr	initBar
Protected Attributes inherited from INTELLI::AbstractWS
INTELLI::join_type_t	myType = INTELLI::CNT_BASED
size_t	countS
size_t	countR
size_t	windowLen = 0
size_t	slideLen = 1
std::vector< size_t >	partitionWeight
std::vector< size_t >	partitionSizeFinal
size_t	threads
size_t	sLen
size_t	rLen
bool	runTimeScheduling = false
bool	timeBased = false
bool	isRunning = false
struct timeval	timeSys
TuplePtrQueue	TuplePtrQueueInS
TuplePtrQueue	TuplePtrQueueInR
string	nameTag

Additional Inherited Members
Protected Member Functions inherited from INTELLI::AbstractWS
size_t	oldestWindowBelong (size_t ts)
	To get the possible oldest a time stamp belongs to. More...

Detailed Description

The eager window slider of handshake join.

Note

detailed description: To init and run, follow the functions below to start a WS

• Configure the window type, time or count, setTimeBased
• Configure window length: setWindowLen
• Configure slide length: setSlideLen (Only support 0 for hand shake join, means fixed slide, i.e., every tuple)
• Set parallel executing behavior on SMP,setParallelSMP
• Optional, (setRunTimeScheduling)
• To make the parallel join processors started, initJoinProcessors
• Feed tuples feedTupleS or feedTupleR
• Terminate, by terminateJoinProcessors

Member Function Documentation

feedTupleR()

void INTELLI::HandShakeWS::feedTupleR ( TuplePtr  tr )

virtual

to feed a tuple R

Parameters

tr	the tuple r

Note

this function is thread-safe :)

Reimplemented from INTELLI::AbstractWS.

feedTupleS()

void INTELLI::HandShakeWS::feedTupleS ( TuplePtr  ts )

virtual

to feed a tuple s

Parameters

ts	the tuple s

Note

this function is thread-safe :)

Reimplemented from INTELLI::AbstractWS.

getJoinResult()

size_t INTELLI::HandShakeWS::getJoinResult ( )

virtual

to get the result of join

Returns

how many tuples are joined

Note

only called after all join processors are stopped ,use terminateJoinProcessors to achieve this

Reimplemented from INTELLI::AbstractWS.

initJoinProcessors()

void INTELLI::HandShakeWS::initJoinProcessors ( )

virtual

to init the initJoinProcessors

Note

only after this is called can we start to feed tuples

Reimplemented from INTELLI::AbstractWS.

---

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

• include/WindowSlider/HandShakeWS.h