niklas/cyclonedds
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add guard conditions

Browse source 
Signed-off-by: Erik Boasson <eb@ilities.com>
This commit is contained in:
Erik Boasson 2018-07-13 08:47:29 +02:00
parent 414be4a569
commit 24f622b114
7 changed files with 249 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

77
src/core/ddsc/include/ddsc/dds.h
View file

@ -1821,6 +1821,83 @@ dds_create_querycondition(
_In_ uint32_t mask,
_In_ dds_querycondition_filter_fn filter);
/**
* @brief Creates a guardcondition.
*
* Waitsets allow waiting for an event on some of any set of entities.
* This means that the guardcondition can be used to wake up a waitset when
* data is in the reader history with states that matches the given mask.
*
* @returns A valid condition handle or an error code.
*
* @retval >0
* A valid condition handle
* @retval DDS_RETCODE_ERROR
* An internal error has occurred.
* @retval DDS_RETCODE_ILLEGAL_OPERATION
* The operation is invoked on an inappropriate object.
* @retval DDS_RETCODE_ALREADY_DELETED
* The entity has already been deleted.
*/
_Pre_satisfies_((reader & DDS_ENTITY_KIND_MASK) == DDS_KIND_PARTICIPANT)
DDS_EXPORT _Must_inspect_result_ dds_entity_t
dds_create_guardcondition(
_In_ dds_entity_t participant);
/**
* @brief Sets the trigger status of a guardcondition.
*
* @retval DDS_RETCODE_OK
* Operation successful
* @retval DDS_RETCODE_ERROR
* An internal error has occurred.
* @retval DDS_RETCODE_ILLEGAL_OPERATION
* The operation is invoked on an inappropriate object.
* @retval DDS_RETCODE_ALREADY_DELETED
* The entity has already been deleted.
*/
_Pre_satisfies_((reader & DDS_ENTITY_KIND_MASK) == DDS_KIND_COND_GUARD)
DDS_EXPORT dds_return_t
dds_set_guardcondition(
_In_ dds_entity_t guardcond,
_In_ bool triggered);
/**
* @brief Reads the trigger status of a guardcondition.
*
* @retval DDS_RETCODE_OK
* Operation successful
* @retval DDS_RETCODE_ERROR
* An internal error has occurred.
* @retval DDS_RETCODE_ILLEGAL_OPERATION
* The operation is invoked on an inappropriate object.
* @retval DDS_RETCODE_ALREADY_DELETED
* The entity has already been deleted.
*/
_Pre_satisfies_((reader & DDS_ENTITY_KIND_MASK) == DDS_KIND_COND_GUARD)
DDS_EXPORT dds_return_t
dds_read_guardcondition(
_In_ dds_entity_t guardcond,
_Out_ bool *triggered);
/**
* @brief Reads and resets the trigger status of a guardcondition.
*
* @retval DDS_RETCODE_OK
* Operation successful
* @retval DDS_RETCODE_ERROR
* An internal error has occurred.
* @retval DDS_RETCODE_ILLEGAL_OPERATION
* The operation is invoked on an inappropriate object.
* @retval DDS_RETCODE_ALREADY_DELETED
* The entity has already been deleted.
*/
_Pre_satisfies_((reader & DDS_ENTITY_KIND_MASK) == DDS_KIND_COND_GUARD)
DDS_EXPORT dds_return_t
dds_take_guardcondition(
_In_ dds_entity_t guardcond,
_Out_ bool *triggered);
/**
* @brief Waitset attachment argument.
*

5
src/core/ddsc/include/ddsc/dds_public_impl.h
View file

@ -109,8 +109,9 @@ typedef enum dds_entity_kind
DDS_KIND_PUBLISHER = 0x06000000,
DDS_KIND_COND_READ = 0x07000000,
DDS_KIND_COND_QUERY = 0x08000000,
DDS_KIND_WAITSET = 0x09000000,
DDS_KIND_INTERNAL = 0x0A000000,
DDS_KIND_COND_GUARD = 0x09000000,
DDS_KIND_WAITSET = 0x0A000000,
DDS_KIND_INTERNAL = 0x0B000000,
}
dds_entity_kind_t;