![]() |
MHEG5
18.9.0
MHEG5 Documentation
|
Event handling. Implementation of a combined queue for events and actions. This is the eventsystem which drives the MHEG engine. More...
Go to the source code of this file.
Enumerations | |
enum | E_ENGINE_EVENT { EE_GROUP_ID_REF_ERROR = 2, EE_CONTENT_REF_ERROR = 3, EE_KEYPRESS_TEXT = 4, EE_VIDEO_PREF_CHANGED = 6, EE_ENGINE_RESUME = 7, EE_NETWORK_BOOT_INFO = 9, EE_NON_DESTRUCTIVE_TUNE_OK = 10, EE_KEYPRESS_CANCEL = 16, EE_PVR_LIST_CHANGED = 20, EE_KEYPRESS_RED = 100, EE_KEYPRESS_GREEN = 101, EE_KEYPRESS_YELLOW = 102, EE_KEYPRESS_BLUE = 103, EE_KEYPRESS_INFO = 105, EE_KEYPRESS_EPG = 300, EE_AUDIO_LANG_PREF_CHANGED = 301, EE_SUBTITLE_LANG_PREF_CHANGED = 302 } |
Functions | |
void | MHEG5queueResetScene (MHEG5Root *grp) |
Reset both event queues and the action queue, discarding any pending events and actions for this scene. More... | |
void | MHEG5queueResolveTargets (MHEG5ActionList actions) |
Finds targets for the action list. More... | |
void | MHEG5queueUnresolveTargets (MHEG5ActionList actions) |
Clear targets for the action list. More... | |
void | MHEG5actionListExecute (MHEG5Group *source, MHEG5ActionList actions) |
Execute the supplied list of actions immediately. The actions will have been executed by the time the function returns. More... | |
void | MHEG5PrependActionList (MHEG5ActionList actions) |
Execute the supplied list of actions before others. More... | |
void | MHEG5AppendActionList (MHEG5ActionList actions) |
The supplied list of actions should execute after any already on queue. More... | |
void | MHEG5sendEvent (MHEG5Root *source, MHEG5EventType event, MHEG5Int data) |
Store an event in the asynchronous event queue. More... | |
void | MHEG5sendAppEngineEvent (E_ENGINE_EVENT engine_event) |
Store an Engine event in the asynchronous event queue. More... | |
void | MHEG5sendSync (MHEG5Root *source, MHEG5EventType event, MHEG5Int data) |
Store an event in the synchronous event queue. More... | |
void | MHEG5stopEventsAndResetQueue (void) |
Discard any pending events and actions and prevent future events from being queued. And reset queues. See also MHEG5queueEvents. More... | |
void | MHEG5queueEvents (void) |
Allow future events to be stored in the event queues. See also MHEG5stopEventsAndQueueReset. More... | |
void | MHEG5processQueue (void) |
Process all pending events and actions. After processing all events and actions, Normally there will not be any pending synchronous events or actions when this function is entered. The exception to this is when event processing has been disabled and re-enabled. In this case, any pending synchronous events should be processed before processing asynchronous events. More... | |
void | MHEG5enableEventProcessing (MHEG5Bool enable) |
Enable or disable engine event processing. This function is used to implement the Call action for resident programs that normally fork by disabling engine event progressing until the program finishes. More... | |
void | MHEG5eventProcessingReset (void) |
Causes the MHEG5enableEventProcessing counter to be reset to 0, and event processing to be enabled. This function is called when the engine is terminated to ensure that event processing will be enabled next time the engine is started. More... | |
void | MHEG5requestDisplayUpdate (void) |
Request display update at the end of synchronous event processing. More... | |
int | MHEG5InitQueues (void) |
void | MHEG5ExitQueues (void) |
Event handling. Implementation of a combined queue for events and actions. This is the eventsystem which drives the MHEG engine.
Definition in file mh5queue.h.
enum E_ENGINE_EVENT |
Definition at line 43 of file mh5queue.h.
void MHEG5actionListExecute | ( | MHEG5Group * | source, |
MHEG5ActionList | act_q | ||
) |
Execute the supplied list of actions immediately. The actions will have been executed by the time the function returns.
source | Source object generating the actions |
actions | List of actions to execute |
Execute the supplied list of actions immediately. The actions will have been executed by the time the function returns.
source | Source object generating the actions |
actions | List of actions to execute |
Definition at line 1400 of file mh5queue.c.
void MHEG5AppendActionList | ( | MHEG5ActionList | actions | ) |
The supplied list of actions should execute after any already on queue.
actions | List of actions to execute |
Definition at line 1032 of file mh5queue.c.
void MHEG5enableEventProcessing | ( | MHEG5Bool | enable | ) |
Enable or disable engine event processing. This function is used to implement the Call action for resident programs that normally fork by disabling engine event progressing until the program finishes.
enable | MHEG5TRUE to enable event processing, MHEG5FALSE to disable event processing. |
Enable or disable engine event processing. This function is used to implement the Call action for resident programs that normally fork by disabling engine event progressing until the program finishes.
enable | MHEG5TRUE to enable event processing, MHEG5FALSE to disable event processing. |
Definition at line 1751 of file mh5queue.c.
void MHEG5eventProcessingReset | ( | void | ) |
Causes the MHEG5enableEventProcessing counter to be reset to 0, and event processing to be enabled. This function is called when the engine is terminated to ensure that event processing will be enabled next time the engine is started.
Definition at line 1795 of file mh5queue.c.
void MHEG5ExitQueues | ( | void | ) |
Definition at line 1000 of file mh5queue.c.
int MHEG5InitQueues | ( | void | ) |
Definition at line 858 of file mh5queue.c.
void MHEG5PrependActionList | ( | MHEG5ActionList | actions | ) |
Execute the supplied list of actions before others.
actions | List of actions to execute |
Execute the supplied list of actions before others.
actions | List of actions to execute |
Definition at line 1502 of file mh5queue.c.
void MHEG5processQueue | ( | void | ) |
Process all pending events and actions. After processing all events and actions, Normally there will not be any pending synchronous events or actions when this function is entered. The exception to this is when event processing has been disabled and re-enabled. In this case, any pending synchronous events should be processed before processing asynchronous events.
Definition at line 1333 of file mh5queue.c.
void MHEG5queueEvents | ( | void | ) |
Allow future events to be stored in the event queues. See also MHEG5stopEventsAndQueueReset.
Allow future events to be stored in the event queues. See also MHEG5stopEventsAndQueueReset.
Definition at line 1528 of file mh5queue.c.
void MHEG5queueResetScene | ( | MHEG5Root * | grp | ) |
Reset both event queues and the action queue, discarding any pending events and actions for this scene.
Definition at line 957 of file mh5queue.c.
void MHEG5queueResolveTargets | ( | MHEG5ActionList | actions | ) |
Finds targets for the action list.
actions | List of actions to execute |
Definition at line 1182 of file mh5queue.c.
void MHEG5queueUnresolveTargets | ( | MHEG5ActionList | actions | ) |
Clear targets for the action list.
actions | List of actions to execute |
Definition at line 1204 of file mh5queue.c.
void MHEG5requestDisplayUpdate | ( | void | ) |
Request display update at the end of synchronous event processing.
Request display update at the end of synchronous event processing.
Definition at line 1855 of file mh5queue.c.
void MHEG5sendAppEngineEvent | ( | E_ENGINE_EVENT | engine_event | ) |
Store an Engine event in the asynchronous event queue.
Definition at line 1633 of file mh5queue.c.
void MHEG5sendEvent | ( | MHEG5Root * | source, |
MHEG5EventType | a_type, | ||
MHEG5Int | data | ||
) |
Store an event in the asynchronous event queue.
source | Source object generating the event |
event | Type of event to send |
data | Event data associated with this event |
Store an event in the asynchronous event queue.
source | Source object generating the event |
event | Type of event to send |
data | Event data associated with this event |
Definition at line 1540 of file mh5queue.c.
void MHEG5sendSync | ( | MHEG5Root * | source, |
MHEG5EventType | e_type, | ||
MHEG5Int | e_data | ||
) |
Store an event in the synchronous event queue.
source | Source object generating the event |
event | Type of event to send |
data | Event data associated with this event |
Definition at line 1651 of file mh5queue.c.
void MHEG5stopEventsAndResetQueue | ( | void | ) |
Discard any pending events and actions and prevent future events from being queued. And reset queues. See also MHEG5queueEvents.
Definition at line 914 of file mh5queue.c.