UniMCI User Documentation

ZIH Logo

unimci-message.h File Reference

Header file for the UniMCI message object. More...

This graph shows which files directly or indirectly include this file:

Data Structures

struct  UNIMCI_MSG
 Describes a message returned by an MPI checker. More...

Enumerations

enum  UNIMCI_MSG_TYPE { UNIMCI_MSG_TYPE_INFO = 0, UNIMCI_MSG_TYPE_WARNING, UNIMCI_MSG_TYPE_ERROR }
 

Describes all types of messages.

More...

Functions

int UNIMCI_msg_free (UNIMCI_MSG **msg)
 Frees a message.
int UNIMCI_msg_new (UNIMCI_MSG **msg)
 Creates a new and empty message.
int UNIMCI_msg_clone (UNIMCI_MSG *msg_in, UNIMCI_MSG **msg_out)
 Clones an existing message.
int UNIMCI_msg_set_text (UNIMCI_MSG *msg_inout, const char *strTextToSet)
 Sets the text of a message.
int UNIMCI_msg_set_reference (UNIMCI_MSG *msg_inout, const char *strReferenceToSet)
 Sets the HTML reference of a message.
int UNIMCI_msg_set_callinfo (UNIMCI_MSG *msg_inout, const char *strCallInfoToSet)
 Sets the callinfo of a message.
int UNIMCI_msg_set_global (UNIMCI_MSG *msg_inout, int numParticipatingRanks, const int *participatingRanks)
 Sets the given message as a global message.

Detailed Description

Header file for the UniMCI message object.

This header describes the message object that is used to pass error messages between the master and the slave. (Master is the tool that uses UniMCI to get MPI checking functionality, slave is the tool used to provide this)

Author:
Tobias Hilbrich
Date:
10.12.2009

Enumeration Type Documentation

Describes all types of messages.

Enumerator:
UNIMCI_MSG_TYPE_INFO 

Used for messages that only contain interesting information.

UNIMCI_MSG_TYPE_WARNING 

Used for MPI constructs that are dangerous or of bad style, but still legal.

UNIMCI_MSG_TYPE_ERROR 

Used for actual violations to the MPI standard.


Function Documentation

int UNIMCI_msg_clone ( UNIMCI_MSG msg_in,
UNIMCI_MSG **  msg_out 
)

Clones an existing message.

Also clones all memory used by a message.

Parameters:
msg_in the message to clone.
msg_out the newly created message.
Returns:
0 if the operation was successful, 1 otherwise.
int UNIMCI_msg_free ( UNIMCI_MSG **  msg  ) 

Frees a message.

Parameters:
msg the message to be freed, is set to NULL.
Returns:
0 if the operation was successful, 1 otherwise.
int UNIMCI_msg_new ( UNIMCI_MSG **  msg  ) 

Creates a new and empty message.

All strings will be set to NULL and still have to be initialized.

Parameters:
msg the message to be created.
Returns:
0 if the operation was successful, 1 otherwise.
int UNIMCI_msg_set_callinfo ( UNIMCI_MSG msg_inout,
const char *  strCallInfoToSet 
)

Sets the callinfo of a message.

If msg_inout->strCallInfo is not NULL, it will be freed.

Parameters:
msg_inout the message for which the call info is set.
strCallInfoToSet the new call info.
Returns:
0 if the operation was successful, 1 otherwise.
int UNIMCI_msg_set_global ( UNIMCI_MSG msg_inout,
int  numParticipatingRanks,
const int *  participatingRanks 
)

Sets the given message as a global message.

If msg_inout->numParticipatingRanks is not NULL, it will be freed.

Parameters:
msg_inout the message which is set as global.
numParticipatingRanks the number of ranks that participate in the global message.
participatingRanks the individual ranks that participate in the global message, array with numParticipatingRanks entries.
Returns:
0 if the operation was successful, 1 otherwise.
int UNIMCI_msg_set_reference ( UNIMCI_MSG msg_inout,
const char *  strReferenceToSet 
)

Sets the HTML reference of a message.

If msg_inout->strHTMLReference is not NULL, it will be freed.

Parameters:
msg_inout the message for which the HTML reference is set.
strReferenceToSet the new HTML reference.
Returns:
0 if the operation was successful, 1 otherwise.
int UNIMCI_msg_set_text ( UNIMCI_MSG msg_inout,
const char *  strTextToSet 
)

Sets the text of a message.

If msg_inout->strText is not NULL, it will be freed.

Parameters:
msg_inout the message for which the text is set.
strTextToSet the new text.
Returns:
0 if the operation was successful, 1 otherwise.

Generated on Tue May 18 10:09:18 2010 for UniMCI by  doxygen 1.6.1