rwtMakeThreadIOUFunction()

Module:  Threads   Package:  Threading

Global Functions and Macros

• Local Index
• Header File
• Description
• Example Using Templates
• Example Using Macros
• Global Function Templates
• Macros (for Use With Global Functions)
• Macros (for Use With Member Functions
• See Also

Members

rwtMakeThreadIOUFunctionM()

rwtMakeThreadIOUFunctionMA1()

rwtMakeThreadIOUFunctionMA2()

rwtMakeThreadIOUFunctionMA3()

Non-Members

rwtMakeThreadIOUFunction() rwtMakeThreadIOUFunctionG()

rwtMakeThreadIOUFunctionGA1() rwtMakeThreadIOUFunctionGA2()

rwtMakeThreadIOUFunctionGA3()

#include <rw/thread/rwtMakeThreadIOUFunction.h>

The easiest way to create a thread with the Threads Module is to begin with rwtMakeThreadIOUFunction(). 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, rwtMakeThreadIOUFunction() allows you to specify the values that should be passed to that function. Note that threads created with rwtMakeThreadIOUFunction() allow you to extract the return value from the associated function. This distinguishes them from those created by rwtMakeThreadFunction(), which do not.

rwtMakeThreadIOUFunction() 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 cannot 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 rwtMakeThreadIOUFunction(), 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 rwtMakeThreadIOUFunctionG() to create a thread that calls a global function that takes no arguments. The macro rwtMakeThreadIOUFunctionMA2() will create a thread that calls a member function that takes two arguments.

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 RWTThreadIOUFunction set to call foo(3.14,11):
RWTThreadIOUFunction<int> t1 
      = rwtMakeThreadIOUFunction(foo, 3.14, 11);

// Create an RWTThreadIOUFunction set to call a.bar(`x'):
RWTThreadIOUFunction<int> t2 
      = rwtMakeThreadIOUFunction(a, &A::bar, `x');

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 RWTThreadIOUFunction set to call foo(3.14,11):
RWTThreadIOUFunction<int> t1 
 = rwtMakeThreadIOUFunctionGA2(int, foo, double, 3.14, long, 11);

// Create an RWTThreadIOUFunction set to call a.bar(`x'):
RWTThreadIOUFunction<int> t2 
 = rwtMakeThreadIOUFunctionMA1(A, a, int, &A::bar, char, `x');

template <class R>
RWTThreadIOUFunction<R> 
rwtMakeThreadIOUFunction(R (*function)(void))

Creates an RWTThreadIOUFunction set to call function().

template <class R, class A1, class AA1>
RWTThreadIOUFunction<R> 
rwtMakeThreadIOUFunction(R (*function)(A1), AA1 a1)

Creates an RWTThreadIOUFunction 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>
RWTThreadIOUFunction<R> 
rwtMakeThreadIOUFunction(R (*function)(A1,A2), AA1 a1, AA2 a2)

Creates an RWTThreadIOUFunction 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>
RWTThreadIOUFunction<R> 
rwtMakeThreadIOUFunction(R (*function)(A1,A2,A3), 
                        AA1 a1, AA2 a2,AA3 a3)

Creates an RWTThreadIOUFunction 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>
RWTThreadIOUFunction<R> 
rwtMakeThreadIOUFunction(Callee& callee,
                        R (Callee::*function)(void))

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

template <class Callee, class R, class A1, class AA1>
RWTThreadIOUFunction<R>
rwtMakeThreadIOUFunction(Callee& callee,
                        R (Callee::*function)(A1), AA1 a1)

Creates an RWTThreadIOUFunction 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>
RWTThreadIOUFunction<R> 
rwtMakeThreadIOUFunction(Callee& callee,
                R (Callee::*function)(A1,A2), AA1 a1, AA2 a2)

Creates an RWTThreadIOUFunction 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>
RWTThreadIOUFunction<R> 
rwtMakeThreadIOUFunction(Callee& callee, 
      R (Callee::*function)(A1,A2,A3), AA1 a1, AA2 a2, AA3 a3)

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

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.

rwtMakeThreadIOUFunctionG(R,function)

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

rwtMakeThreadIOUFunctionGA1(R,function,A1,a1)

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

rwtMakeThreadIOUFunctionGA2(R,function,A1,a1,A2,a2)

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

rwtMakeThreadIOUFunctionGA3(R,function,A1,a1,A2,a2,A3,a3)

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

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.

rwtMakeThreadIOUFunctionM(Callee,callee,R,function) 

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

rwtMakeThreadIOUFunctionMA1(Callee,callee,R,function,A1,a1) 

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

rwtMakeThreadIOUFunctionMA2(Callee,callee,R,function,A1,a1,
                                         A2,a2) 

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

rwtMakeThreadIOUFunctionMA3(Callee,callee,R,function,
                          A1,a1,A2,a2,A3,a3) 

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

RWTThreadIOUFunction<Return>

© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.