CoreDX DDS C Reference Manual
Related Functions | List of all members
DDS_GuardCondition Struct Reference

A DDS_GuardCondition is a condition where the trigger_value is under application control. More...

Related Functions

(Note that these are not member functions.)

DDS_GuardCondition DDS_GuardCondition__alloc (void)
 This routine allocates a DDS_GuardCondition. More...
 
void DDS_GuardCondition__free (struct _GuardCondition *gc)
 This routine destroys the provided DDS_GuardCondition. More...
 
unsigned char DDS_GuardCondition_get_trigger_value (DDS_GuardCondition gc)
 This routine returns the current value of the trigger_value in gc. More...
 
DDS_ReturnCode_t DDS_GuardCondition_set_trigger_value (DDS_GuardCondition gc, unsigned char v)
 This routine set the current value of the trigger_value in gc. More...
 

Detailed Description

A DDS_GuardCondition is a condition where the trigger_value is under application control.

Friends And Related Function Documentation

DDS_GuardCondition DDS_GuardCondition__alloc ( void  )
related

This routine allocates a DDS_GuardCondition.

The returned GuardCondition should be destroyed by a call to DDS_GuardCondition__free().

void DDS_GuardCondition__free ( struct _GuardCondition *  gc)
related

This routine destroys the provided DDS_GuardCondition.

The provided GuardCondition must have been previously allocated by a call to DDS_GuardCondition__alloc(). The caller must ensure that the GuardCondition is not attached to any WaitSets prior to calling DDS_GuardCondition__free().

unsigned char DDS_GuardCondition_get_trigger_value ( DDS_GuardCondition  gc)
related

This routine returns the current value of the trigger_value in gc.

A non-zero return value indicates that the trigger_value is TRUE.

A zero return value indicates that the trigger_value is FALSE.

DDS_ReturnCode_t DDS_GuardCondition_set_trigger_value ( DDS_GuardCondition  gc,
unsigned char  v 
)
related

This routine set the current value of the trigger_value in gc.

A non-zero v argument indicates that the trigger_value is TRUE.

A zero v argument indicates that the trigger_value is FALSE. Setting the trigger value to a non-zero state will cause any threads that are waiting on a WaitSet with this GuardCondition attached to unblock. [In other words, the DDS_WaitSet_wait() routine will return if the WaitSet has this GuardCondition attached to it.]


© 2009-2017 Twin Oaks Computing, Inc
Castle Rock, CO 80108
All rights reserved.