RCCE_recv.3.svn-base 845 B

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. .TH RCCE 3 2010-02-04 "RCCE MANPAGE" "RCCE Library"
  2. .SH NAME
  3. RCCE_recv \- RCCE receive message
  4. .SH SYNOPSIS
  5. .B #include <rcce.h>
  6. .sp
  7. .BI "int RCCE_recv(char *" privbuf ", size_t" size ",int" ID );
  8. .SH DESCRIPTION
  9. .BR RCCE_send()
  10. receives an arbitrarily sized buffer (does not have to be a
  11. multiple of 32 bytes) of data from the private memory of
  12. the sending UE to the private memory of the receiving UE.
  13. Its parameters must be matched exactly by those on the
  14. receiving side.
  15. .TP 10
  16. .B privbuf
  17. Starting address (private memory) of data to be received.
  18. .TP
  19. .B size
  20. Size of message in bytes.
  21. .TP
  22. .B ID
  23. Rank of target UE.
  24. .SH "RETURN VALUE"
  25. Upon successful completion
  26. .BR RCCE_send ()
  27. returns
  28. .BR RCCE_SUCCESS .
  29. .SH ERRORS
  30. Look in
  31. .BR rcce.h
  32. for additional error codes.
  33. .SH "SEE ALSO"
  34. rcce.h(5)
  35. .SH EXAMPLE
  36. .PP
  37. To be supplied.