RTI Connext DDS Micro C API  Version 4.0.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
Time Support

Time and duration types and defines. More...

Data Structures

struct  DDS_Time_t
 Type for time representation. More...
struct  DDS_Duration_t
 Type for duration representation. More...

Macros

#define DDS_TIME_ZERO
 The default instant in time: zero seconds and zero nanoseconds.

Functions

DDS_Boolean DDS_Time_greater_than (const struct DDS_Time_t *l, const struct DDS_Time_t *r)
DDS_Boolean DDS_Time_is_zero (const struct DDS_Time_t *time)
 Check if time is zero.
DDS_Boolean DDS_Duration_is_infinite (const struct DDS_Duration_t *duration)
int DDS_Duration_compare (const struct DDS_Duration_t *left, const struct DDS_Duration_t *right)
void DDS_Duration_to_ntp_time (const struct DDS_Duration_t *self, struct OSAPI_NtpTime *dst)
 Converts a DDS_Duration_t instance into an equivalent OSAPI_NtpTime value.
void DDS_Duration_from_ntp_time (struct DDS_Duration_t *self, const struct OSAPI_NtpTime *src)
 Fills a DDS_Duration_t instance with the value contained in an OSAPI_NtpTime object.
DDS_Boolean DDS_Duration_equal (const struct DDS_Duration_t *self, const struct DDS_Duration_t *other)
DDS_Boolean DDS_Duration_is_zero (const struct DDS_Duration_t *duration)

Variables

const DDS_Long DDS_TIME_INVALID_SEC
 A sentinel indicating an invalid second of time.
const DDS_UnsignedLong DDS_TIME_INVALID_NSEC
 A sentinel indicating an invalid nano-second of time.
struct DDS_Time_t DDS_TIME_INVALID
 A sentinel indicating an invalid time.
const DDS_Long DDS_DURATION_INFINITE_SEC
 An infinite second period of time.
const DDS_UnsignedLong DDS_DURATION_INFINITE_NSEC
 An infinite nano-second period of time.
struct DDS_Duration_t DDS_DURATION_INFINITE
 An infinite period of time.
const DDS_Long DDS_DURATION_ZERO_SEC
 A zero-length second period of time.
const DDS_UnsignedLong DDS_DURATION_ZERO_NSEC
 A zero-length nano-second period of time.
struct DDS_Duration_t DDS_DURATION_ZERO
 A zero-length period of time.

Detailed Description

Time and duration types and defines.


Macro Definition Documentation

#define DDS_TIME_ZERO

The default instant in time: zero seconds and zero nanoseconds.


Function Documentation

DDS_Boolean DDS_Time_greater_than ( const struct DDS_Time_t l,
const struct DDS_Time_t r 
)
Returns:
DDS_BOOLEAN_TRUE if the first time is greater than the second.
DDS_Boolean DDS_Time_is_zero ( const struct DDS_Time_t time)

Check if time is zero.

Returns:
DDS_BOOLEAN_TRUE if the given time is equal to DDS_TIME_ZERO or DDS_BOOLEAN_FALSE otherwise.
DDS_Boolean DDS_Duration_is_infinite ( const struct DDS_Duration_t duration)
Returns:
DDS_BOOLEAN_TRUE if the given duration is of infinite length.
int DDS_Duration_compare ( const struct DDS_Duration_t left,
const struct DDS_Duration_t right 
)
Parameters:
left<<in>> Duration to compare. Cannot be NULL.
right<<in>> Duration to compare. Cannot be NULL.
Returns:
If the two durations are equal, the function returns 0. If left is greater than right the function returns a positive number; otherwise, it returns a negative number.
void DDS_Duration_to_ntp_time ( const struct DDS_Duration_t self,
struct OSAPI_NtpTime dst 
)

Converts a DDS_Duration_t instance into an equivalent OSAPI_NtpTime value.

Parameters:
self<<in>> This Duration_t. Cannot be NULL.
dst<<out>> The OSAPI_NtpTime object where the converted value will be stored.
void DDS_Duration_from_ntp_time ( struct DDS_Duration_t self,
const struct OSAPI_NtpTime src 
)

Fills a DDS_Duration_t instance with the value contained in an OSAPI_NtpTime object.

Parameters:
self<<in>> This Duration_t. Cannot be NULL.
src<<in>> The OSAPI_NtpTime object where the value will be read from.
DDS_Boolean DDS_Duration_equal ( const struct DDS_Duration_t self,
const struct DDS_Duration_t other 
)
Parameters:
self<<in>> Duration to compare. Cannot be NULL.
other<<in>> Duration to be compared to this one. Cannot be NULL.
Returns:
DDS_BOOLEAN_TRUE if the two objects contain the same value, DDS_BOOLEAN_FALSE otherwise.
DDS_Boolean DDS_Duration_is_zero ( const struct DDS_Duration_t duration)
Returns:
DDS_BOOLEAN_TRUE if the given duration is of zero length.

Variable Documentation

const DDS_Long DDS_TIME_INVALID_SEC

A sentinel indicating an invalid second of time.

const DDS_UnsignedLong DDS_TIME_INVALID_NSEC

A sentinel indicating an invalid nano-second of time.

struct DDS_Time_t DDS_TIME_INVALID

A sentinel indicating an invalid time.

const DDS_Long DDS_DURATION_INFINITE_SEC

An infinite second period of time.

const DDS_UnsignedLong DDS_DURATION_INFINITE_NSEC

An infinite nano-second period of time.

struct DDS_Duration_t DDS_DURATION_INFINITE

An infinite period of time.

const DDS_Long DDS_DURATION_ZERO_SEC

A zero-length second period of time.

const DDS_UnsignedLong DDS_DURATION_ZERO_NSEC

A zero-length nano-second period of time.

struct DDS_Duration_t DDS_DURATION_ZERO

A zero-length period of time.


RTI Connext DDS Micro C API Version 4.0.1 Copyright © Mon Jun 3 2024 Real-Time Innovations, Inc