Stalling User Interface
API Reference Manual  /  Simulator API  /  Simulator API Functions  / 

Time and Events

SIM_get_global_message

Name

SIM_get_global_message — obtain current global message

Synopsis

C and DML

#include <simics/simulator-api.h> // in C
import "simics/simulator-api.dml"; // in DML

const char *
SIM_get_global_message(void *ref);

Python

import simics

simics.SIM_get_global_message(...)

Description

Return the global message currently being triggered, if ref does not match the reference of the source trigger, otherwise return NULL.

This function must only be called from a callback of the global notifier Sim_Global_Notify_Message.

Execution Context

Global Context

See Also

SIM_trigger_global_message

SIM_trigger_global_message

Name

SIM_trigger_global_message — queue up a global message

Synopsis

C and DML

#include <simics/simulator-api.h> // in C
import "simics/simulator-api.dml"; // in DML

void
SIM_trigger_global_message(const char *msg, void *ref);

Python

import simics

simics.SIM_trigger_global_message(...)

Description

This queues up a global message, which will be dispatched shortly in global context, to all listeners of the Sim_Global_Notify_Message global notifier. The ref parameter is the reference of the source, or NULL to dispatch to all listeners.

The notifier callbacks should use SIM_get_global_message to retrieve the message. Only callbacks that provide a NULL reference or a reference different from ref will obtain the message.

Execution Context

All contexts including Threaded Context

See Also

SIM_get_global_message

Stalling User Interface