rwtMakeThreadFunction Macros and Functions

Module Description

Header File

#include <rw/thread/rwtMakeThreadFunction.h>

The easiest way to create a thread with the Threads Module is to begin with rwtMakeThreadFunction(). By supplying a global or member function pointer you control what your thread will do after starting. If you wish your thread to start by calling a function that takes arguments, rwtMakeThreadFunction() allows you to specify the values that should be passed to that function. Note that threads created with rwtMakeThreadFunction() will ignore any return values from the associated function. To create threads from which you can extract a return value, see rwtMakeThreadIOUFunction().

rwtMakeThreadFunction() comes in two flavors. First, there is a set of overloaded global function templates. Since not all compilers are able to handle templates to the degree required by these functions, we also provide a corresponding set of macros. The template functions are slightly easier to use and you only have to remember one name. The macros are more portable but they do require more arguments, and as we can not overload macros, each must have a unique name.

In naming the macros we have employed a convention to make the names easier to remember. Each name begins with rwtMakeThreadFunction, which will be followed by either a G if the macro is expecting a global function, or an M if it is expecting a member function. At that point the name is complete if the associated global or member function takes no arguments. Otherwise we add one of A1, A2, or A3 for functions with 1, 2, or 3 arguments respectively. For example, you will use macro rwtMakeThreadFunctionG() to create a thread that calls a global function that takes no arguments. The macro rwtMakeThreadFunctionMA2() will create a thread that calls a member function that takes two arguments.

Example

Example Using Templates

class A {
  public:
    int bar(char);  // Member function with 1 argument
  };

  A a;  // an instance of class A

  int foo(double, long);  // Global function with 2 arguments

  // Create an RWThreadFunction set to call foo(3.14,11):
  RWThreadFunction t1 = rwtMakeThreadFunction(foo, 3.14, 11);

  // Create an RWThreadFunction set to call a.bar(`x'):
  RWThreadFunction t2 = rwtMakeThreadFunction(a, &A::bar, `x');

Example Using Macros

class A {
  public:
    int bar(char);  // Member function with 1 argument
};

A a;  // an instance of class A

int foo(double, long);  // Global function with 2 arguments

// Create an RWThreadFunction set to call foo(3.14,11):
RWThreadFunction t1
    = rwtMakeThreadFunctionGA2(int, foo, double, 3.14, long, 11);

// Create an RWThreadFunction set to call a.bar(`x'):
RWThreadFunction t2
      = rwtMakeThreadFunctionMA1(A, a, int, &A::bar, char, `x');

Macros (for Use With Global Functions)

The macros in this section use the following naming conventions for the macro arguments:

R	Type name of the function return value.
function	Global function pointer.
A1	Type name of the first argument.
a1	Expression that can be converted to an instance of A1.
A2	Type name of the second argument.
a2	Expression that can be converted to an instance of A2.
A3	Type name of the third argument.
a3	Expression that can be converted to an instance of A3.

Macros (for Use With Member Functions)

The macros in this section use the following naming conventions for the macro arguments:

Callee	Type name of the function's class.
callee	Expression that results in a reference to a Callee instance.
R	Type name of the function return value.
function	Pointer to member function of class Callee.
A1	Type name of the first argument.
a1	Expression that can be converted to an instance of A1.
A2	Type name of the second argument.
a2	Expression that can be converted to an instance of A2.
A3	Type name of the second argument.
a3	Expression that can be converted to an instance of A3.

See also

RWThreadFunction

Macros
#define	rwtMakeThreadFunctionG(R, function)
#define	rwtMakeThreadFunctionGA1(R, function, A1, a1)
#define	rwtMakeThreadFunctionGA2(R, function, A1, a1, A2, a2)
#define	rwtMakeThreadFunctionGA3(R, function, A1, a1, A2, a2, A3, a3)
#define	rwtMakeThreadFunctionM(Callee, callee, R, function)
#define	rwtMakeThreadFunctionMA1(Callee, callee, R, function, A1, a1)
#define	rwtMakeThreadFunctionMA2(Callee, callee, R, function, A1, a1, A2, a2)
#define	rwtMakeThreadFunctionMA3(Callee, callee, R, function, A1, a1, A2, a2, A3, a3)

Functions
template<class R >
RWThreadFunction	rwtMakeThreadFunction (R(*function)(void))
template<class R , class A1 , class AA1 >
RWThreadFunction	rwtMakeThreadFunction (R(*function)(A1), AA1 a1)
template<class R , class A1 , class A2 , class AA1 , class AA2 >
RWThreadFunction	rwtMakeThreadFunction (R(*function)(A1, A2), AA1 a1, AA2 a2)
template<class R , class A1 , class A2 , class A3 , class AA1 , class AA2 , class AA3 >
RWThreadFunction	rwtMakeThreadFunction (R(*function)(A1, A2, A3), AA1 a1, AA2 a2, AA3 a3)
template<class Callee , class R >
RWThreadFunction	rwtMakeThreadFunction (Callee &callee, R(Callee::*function)(void))
template<class Callee , class R , class A1 , class AA1 >
RWThreadFunction	rwtMakeThreadFunction (Callee &callee, R(Callee::*function)(A1), AA1 a1)
template<class Callee , class R , class A1 , class A2 , class AA1 , class AA2 >
RWThreadFunction	rwtMakeThreadFunction (Callee &callee, R(Callee::*function)(A1, A2), AA1 a1, AA2 a2)
template<class Callee , class R , class A1 , class A2 , class A3 , class AA1 , class AA2 , class AA3 >
RWThreadFunction	rwtMakeThreadFunction (Callee &callee, R(Callee::*function)(A1, A2, A3), AA1 a1, AA2 a2, AA3 a3)

Macro Definition Documentation

#define rwtMakeThreadFunctionG	(		R,
			function
	)

Deprecated:

As of SourcePro 12.5, use RWThreadFunction::make(function) instead.

Creates an RWThreadFunction set to call function(). function must have signature R (*)(void)

#define rwtMakeThreadFunctionGA1	(		R,
			function,
			A1,
			a1
	)

Deprecated:

As of SourcePro 12.5, use RWThreadFunction::make(rwBind(function, a1)) instead.

Creates an RWThreadFunction set to call function(a1). function must have signature R (*)(A1)

#define rwtMakeThreadFunctionGA2	(		R,
			function,
			A1,
			a1,
			A2,
			a2
	)

Deprecated:

As of SourcePro 12.5, use RWThreadFunction::make(rwBind(function, a1, a2)) instead.

Creates an RWThreadFunction set to call function(a1,a2). function must have signature R (*)(A1,A2)

#define rwtMakeThreadFunctionGA3	(		R,
			function,
			A1,
			a1,
			A2,
			a2,
			A3,
			a3
	)

Deprecated:

As of SourcePro 12.5, use RWThreadFunction::make(rwBind(function, a1, a2, a3)) instead.

Creates an RWThreadFunction set to call function(a1,a2,a3). function must have signature R (*)(A1,A2,A3)

#define rwtMakeThreadFunctionM	(		Callee,
			callee,
			R,
			function
	)

Deprecated:

As of SourcePro 12.5, use RWThreadFunction::make(rwBind(function, callee)) instead.

Creates an RWThreadFunction set to call callee.function(). function must have signature R (Caller::*)(void)

#define rwtMakeThreadFunctionMA1	(		Callee,
			callee,
			R,
			function,
			A1,
			a1
	)

Deprecated:

As of SourcePro 12.5, use RWThreadFunction::make(rwBind(function, callee, a1)) instead.

Creates an RWThreadFunction set to call callee.function(a1). function must have signature R (Caller::*)(A1).

#define rwtMakeThreadFunctionMA2	(		Callee,
			callee,
			R,
			function,
			A1,
			a1,
			A2,
			a2
	)

Deprecated:

As of SourcePro 12.5, use RWThreadFunction::make(rwBind(function, callee, a1, a2)) instead.

Creates an RWThreadFunction set to call callee.function(a1,a2). function must have signature R (Caller::*)(A1,A2).

#define rwtMakeThreadFunctionMA3	(		Callee,
			callee,
			R,
			function,
			A1,
			a1,
			A2,
			a2,
			A3,
			a3
	)

Deprecated:

As of SourcePro 12.5, use RWThreadFunction::make(rwBind(function, callee, a1, a2, a3)) instead.

Creates an RWThreadFunction set to call callee.function(a1,a2,a3). function must have signature R (Caller::*)(A1,A2,A3).

Function Documentation

template<class R >

RWThreadFunction rwtMakeThreadFunction ( R(*)(void)  function )

inline

Deprecated:

As of SourcePro 12.5, use RWThreadFunction::make(function) instead.

Creates an RWThreadFunction set to call function().

template<class R , class A1 , class AA1 >

RWThreadFunction rwtMakeThreadFunction ( R(*)(A1)  function, AA1  a1  )

inline

Deprecated:

As of SourcePro 12.5, use RWThreadFunction::make(rwBind(function, a1)) instead.

Creates an RWThreadFunction set to call function(a1). a1 must be convertible to an instance of type A1.

template<class R , class A1 , class A2 , class AA1 , class AA2 >

RWThreadFunction rwtMakeThreadFunction ( R(*)(A1, A2)  function, AA1  a1, AA2  a2  )

inline

Deprecated:

As of SourcePro 12.5, use RWThreadFunction::make(rwBind(function, a1, a2)) instead.

Creates an RWThreadFunction set to call function(a1,a2). a1 and a2 must be convertible to instances of types A1 and A2 respectively.

template<class R , class A1 , class A2 , class A3 , class AA1 , class AA2 , class AA3 >

RWThreadFunction rwtMakeThreadFunction ( R(*)(A1, A2, A3)  function, AA1  a1, AA2  a2, AA3  a3  )

inline

Deprecated:

As of SourcePro 12.5, use RWThreadFunction::make(rwBind(function, a1, a2, a3)) instead.

Creates an RWThreadFunction set to call function(a1,a2,a3). a1, a2, and a3 must be convertible to instances of types A1, A2, and A3 respectively.

template<class Callee , class R >

RWThreadFunction rwtMakeThreadFunction ( Callee &  callee, R(Callee::*)(void)  function  )

inline

Deprecated:

As of SourcePro 12.5, use RWThreadFunction::make(rwBind(function, callee)) instead.

Creates an RWThreadFunction set to call callee.function().

template<class Callee , class R , class A1 , class AA1 >

RWThreadFunction rwtMakeThreadFunction ( Callee &  callee, R(Callee::*)(A1)  function, AA1  a1  )

inline

Deprecated:

As of SourcePro 12.5, use RWThreadFunction::make(rwBind(function, callee, a1)) instead.

Creates an RWThreadFunction set to call callee.function(a1). a1 must be convertible to an instance of A1.

template<class Callee , class R , class A1 , class A2 , class AA1 , class AA2 >

RWThreadFunction rwtMakeThreadFunction ( Callee &  callee, R(Callee::*)(A1, A2)  function, AA1  a1, AA2  a2  )

inline

Deprecated:

As of SourcePro 12.5, use RWThreadFunction::make(rwBind(function, callee, a1, a2)) instead.

Creates an RWThreadFunction set to call callee.function(a1,a2). a1 and a2 must be convertible to instances of types A1 and A2 respectively.

template<class Callee , class R , class A1 , class A2 , class A3 , class AA1 , class AA2 , class AA3 >

RWThreadFunction rwtMakeThreadFunction ( Callee &  callee, R(Callee::*)(A1, A2, A3)  function, AA1  a1, AA2  a2, AA3  a3  )

inline

Deprecated:

As of SourcePro 12.5, use RWThreadFunction::make(rwBind(function, callee, a1, a2, a3)) instead.

Creates an RWThreadFunction set to call callee.function(a1,a2,a3). a1, a2, and a3 must be convertible to instances of types A1, A2, and A3 respectively.