RCCE_barrier.3.svn-base 908 B

12345678910111213141516171819202122232425262728293031323334353637383940
  1. .TH RCCE 3 2010-02-04 "RCCE MANPAGE" "RCCE Library"
  2. .SH NAME
  3. RCCE_barrier\- RCCE intitialization function
  4. .SH SYNOPSIS
  5. .B #include <rcce.h>
  6. .sp
  7. .BI "int RCCE_barrier(RCCE_COMM " comm );
  8. .SH DESCRIPTION
  9. .BR RCCE_barrier()
  10. specifies a barrier at this point in the code. This is a collective routine that
  11. must be called jointly by all UEs in the communicator.
  12. .TP
  13. .B comm
  14. Communicator whose UEs participate in the barrier. Predefined communicators are
  15. RCCE_COMM_WORLD, and, in case of fine-grain power management, RCCE_P_COMM,
  16. which comprises all the UEs that lie in the local power domain. Any other
  17. communicators to be used in a barrier must be constructed by using RCCE_comm_split().
  18. .SH "RETURN VALUE"
  19. Upon successful completion
  20. .BR RCCE_barrier()
  21. returns
  22. .BR RCCE_SUCCESS .
  23. .SH ERRORS
  24. Look in
  25. .BR rcce.h
  26. for additional error codes.
  27. .SH "SEE ALSO"
  28. rcce.h(5)
  29. .SH EXAMPLE
  30. .PP
  31. To be supplied.