Criminy.
[charm.git] / doc / converse / usermain.tex
1 \chapter{Initialization and Completion}
2
3 \function{void ConverseInit(char *argv[])}
4 \index{ConverseInit}
5 \desc{This function initializes the machine interface. It should be
6 called prior to any other Converse functions. 
7 Multiple calls to this function in a process should
8 be avoided. \param{argv} is in similar format as passed to
9 \param{main(argc, argv)}. 
10 It would be utilized by \param{ConverseInit()} to initialize
11 machine specific parameters such as number of processors.}
12
13 \function{void ConverseExit(void)}
14 \index{ConverseExit}
15 \desc{This function frees the resources acquired by Converse and wraps up. 
16 Any other Converse function should not be called after a call to this function.
17 \note{It does not terminate the calling
18 process. A separate call to \param{exit()} is needed after 
19 \param{ConverseExit()} to achieve this.}}
20
21 \function{void user_main(int argc, char **argv)}
22 \index{user_main}
23 \desc{This function must be written by the Converse user.  When the
24 converse program is loaded, this function will be called on ALL
25 processors.}
26