Martini::ExternalControl Namespace Reference

Martini External Control Interface namespace. More...


Classes

union  UCallback
 Union of all external control command callbacks. More...

Typedefs

typedef void(* TConfigureCallback )(char *)
 Function prototype for generating the Set Output Directory event.
typedef void(* TStartCallback )(void)
 Function prototype for generating the Start event.
typedef void(* TStopCallback )(void)
 Function prototype for generating the Stop event.
typedef void(* TAttachCallback )(void)
 Function prototype for generating the Attach event.
typedef void(* TDetachCallback )(void)
 Function prototype for generating the Detach event.
typedef void(* TCustomCommandCallback )(unsigned int, void *)
 Function prototype for generating the Custom Command event.
typedef int(* TRegisterMartiniCallback )(ECommand command, UCallback callback)
 Prototype for the RegisterMartiniCallback function.
typedef void(* TMartiniMessage )(char *szMsg, ESeverityLevel level)
 Prototype for the MartiniMessage function.
typedef void(* TMartiniProcessShutdown )()
 Prototype for the MartiniProcessShutdown function.
typedef TResult(* TECInit )(char **szWorkingDir, const char *szOptions)
 Prototype for the EC_Init function.

Enumerations

enum  ECommand {
  CMD_CONFIGURE, CMD_START, CMD_STOP, CMD_ATTACH,
  CMD_DETACH, CMD_RELOAD_OPTIONS, CMD_CUSTOM, CMD_LAST
}
 Defines the commands supported by the External Control interface. More...
enum  ESeverityLevel { SL_NOT_ERROR, SL_WARNING, SL_FATAL }
 Defines message severity types for the MartiniMessage function. More...


Detailed Description

Defines the Martini External Control Interface API and related data types

Typedef Documentation

typedef void(* TAttachCallback)(void)

Prototype for the callback function the External Control module should invoke to generate the Attach event

typedef void(* TConfigureCallback)(char *)

Prototype for the callback function the External Control module should invoke to generate the Set Output Directory event

typedef void(* TCustomCommandCallback)(unsigned int, void *)

Prototype for the callback function the External Control module should invoke to generate the Custom Command event

Parameters:
[in] commandId a numeric id identifying the command
[in] pData command data

typedef void(* TDetachCallback)(void)

Prototype for the callback function the External Control module should invoke to generate the Detach event

typedef TResult(* TECInit)(char **szWorkingDir, const char *szOptions)

Prototype for the EC_Init function exported from the External Control module.

typedef void(* TMartiniMessage)(char *szMsg, ESeverityLevel level)

Prototype for the MartiniMessage function exported from the External Control module.

typedef void(* TMartiniProcessShutdown)()

Prototype for the MartiniProcessShutdown function exported from the External Control module

typedef int(* TRegisterMartiniCallback)(ECommand command, UCallback callback)

Prototype for the RegisterMartiniCallback function exported from the External Control module.

typedef void(* TStartCallback)(void)

Prototype for the callback function the External Control module should invoke to generate the Start event

typedef void(* TStopCallback)(void)

Prototype for the callback function the External Control module should invoke to generate the Stop event


Enumeration Type Documentation

enum ECommand

Defines the commands supported by the External Control interface

Enumerator:
CMD_CONFIGURE  configures the output directory of the Martini runtime and loaded MPI client.
CMD_START  notifies an MPI client to start collecting information
CMD_STOP  notifies an MPI client to stop collecting information
CMD_ATTACH  notifies an MPI client to enable profiling events
CMD_DETACH  notifies an MPI client to disable profiling events
CMD_RELOAD_OPTIONS  not supported
CMD_CUSTOM  sends a custom command to an MPI client

Defines message severity types for the MartiniMessage function

Enumerator:
SL_NOT_ERROR  information message
SL_WARNING  warning
SL_FATAL  fatal error



Generated on Thu Mar 6 15:07:55 2008 for Martini by doxygen 1.5.5