dds_types.h

Go to the documentation of this file.

/*****************************************************************
 *
 *   file:   dds_types.h
 *   desc:   CoreDX DDS types
 *
 *****************************************************************
 *
 *   Copyright(C) 2006-2016 Twin Oaks Computing, Inc
 *   All rights reserved.   Castle Rock, CO 80108
 *
 *****************************************************************
 *
 *  This software has been provided pursuant to a License Agreement
 *  containing restrictions on its use.  This software contains
 *  valuable trade secrets and proprietary information of
 *  Twin Oaks Computing, Inc and is protected by law.  It may not be
 *  copied or distributed in any form or medium, disclosed to third
 *  parties, reverse engineered or used in any manner not provided
 *  for in said License Agreement except with the prior written
 *  authorization from Twin Oaks Computing, Inc.
 *
 *****************************************************************/
#ifndef _DDS_TYPES_H
#define _DDS_TYPES_H

#include <dds/dds_seq.h>
#include <dds/dds_map.h>
#include <dds/dds_inttypes.h>
#include <dds/coredx_logging.h>  /* logging flags */

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#define DDS_DOMAINID_TYPE_NATIVE          unsigned int
#define DDS_HANDLE_TYPE_NATIVE            intptr_t
#define DDS_HANDLE_NIL_NATIVE             0
#define DDS_HANDLE_DEFAULT_NATIVE         1
#define DDS_BUILTIN_TOPIC_KEY_TYPE_NATIVE int

#define CDX_UNUSED(x) (void)(x)

  typedef unsigned char             DDS_Octet;

  typedef DDS_DOMAINID_TYPE_NATIVE  DDS_DomainId_t;
  typedef DDS_HANDLE_TYPE_NATIVE    DDS_InstanceHandle_t;
  
  typedef int                       DDS_ReturnCode_t;
  typedef int                       DDS_QosPolicyId_t; 
  typedef unsigned int              DDS_SampleStateKind;
  typedef unsigned int              DDS_SampleStateMask;
  typedef unsigned int              DDS_ViewStateKind;
  typedef unsigned int              DDS_ViewStateMask;
  typedef unsigned int              DDS_InstanceStateKind;
  typedef unsigned int              DDS_InstanceStateMask;

  /* for IDL that references 'boolean', these are used: */
# define DDS_TRUE  1
# define DDS_FALSE 0
  
  typedef struct DDS_Time_t
  {
    int          sec;      
    uint32_t     nanosec;  
  } DDS_Time_t;

  /*
   * Pre-defined values
   */
#define  DDS_LENGTH_UNLIMITED         (-1)

#define  DDS_DURATION_INFINITE_SEC    (0x7fffffff)
#define  DDS_DURATION_INFINITE_NSEC   (0xffffffff)
  
#define  DDS_DURATION_ZERO_SEC        ( 0 )
#define  DDS_DURATION_ZERO_NSEC       ( 0 )
  
#define  DDS_TIMESTAMP_INVALID_SEC    ( -1 )
#define  DDS_TIMESTAMP_INVALID_NSEC   ( 0xffffffff )
#define  DDS_TIMESTAMP_INVALID        { DDS_TIMESTAMP_INVALID_SEC, DDS_TIMESTAMP_INVALID_NSEC }

  /* InstanceHandle codes  */
  COREDX_C_API DDS_InstanceHandle_t DDS_HANDLE_NIL;
  COREDX_C_API DDS_InstanceHandle_t DDS_HANDLE_DEFAULT;          /* TOC, Inc defined */
  COREDX_C_API DDS_InstanceHandle_t DDS_HANDLE_NOT_ENABLED;      /* TOC, Inc defined */

  /* Return codes */
#define DDS_RETCODE_OK                             (  0 )
#define DDS_RETCODE_ERROR                          (  1 )
#define DDS_RETCODE_UNSUPPORTED                    (  2 )
#define DDS_RETCODE_BAD_PARAMETER                  (  3 )
#define DDS_RETCODE_PRECONDITION_NOT_MET           (  4 )
#define DDS_RETCODE_OUT_OF_RESOURCES               (  5 )
#define DDS_RETCODE_NOT_ENABLED                    (  6 )
#define DDS_RETCODE_IMMUTABLE_POLICY               (  7 )
#define DDS_RETCODE_INCONSISTENT_POLICY            (  8 )
#define DDS_RETCODE_ALREADY_DELETED                (  9 )
#define DDS_RETCODE_TIMEOUT                        ( 10 )
#define DDS_RETCODE_NO_DATA                        ( 11 )

  /* Sample states */
#define  DDS_READ_SAMPLE_STATE                     ( 0x0001 )
#define  DDS_NOT_READ_SAMPLE_STATE                 ( 0x0002 )
#define  DDS_ANY_SAMPLE_STATE                      ( 0x00FF )

  /* View states */  
#define  DDS_NEW_VIEW_STATE                        ( 0x0001 )
#define  DDS_NOT_NEW_VIEW_STATE                    ( 0x0002 )
#define  DDS_ANY_VIEW_STATE                        ( 0x00FF )
  
  /* Instance states to support reads */
#define  DDS_ALIVE_INSTANCE_STATE                  ( 0x0001 )
#define  DDS_NOT_ALIVE_DISPOSED_INSTANCE_STATE     ( 0x0002 )
#define  DDS_NOT_ALIVE_NO_WRITERS_INSTANCE_STATE   ( 0x0004 )
  
  /* This is a bit-mask InstanceStateKind */
#define  DDS_NOT_ALIVE_INSTANCE_STATE              ( 0x0006 )
#define  DDS_ANY_INSTANCE_STATE                    ( 0x00FF )

  /* Status to support listeners and conditions  */
  typedef unsigned int DDS_StatusKind;
  typedef unsigned int DDS_StatusMask;    /* bit-mask StatusKind */

#define DDS_NO_STATUS                         0x0000
#define DDS_STATUS_MASK_NONE                  0x0000
#define DDS_INCONSISTENT_TOPIC_STATUS         0x0001 
#define DDS_OFFERED_DEADLINE_MISSED_STATUS    0x0002
#define DDS_REQUESTED_DEADLINE_MISSED_STATUS  0x0004
#define DDS_OFFERED_INCOMPATIBLE_QOS_STATUS   0x0008
#define DDS_REQUESTED_INCOMPATIBLE_QOS_STATUS 0x0010
#define DDS_SAMPLE_LOST_STATUS                0x0020
#define DDS_SAMPLE_REJECTED_STATUS            0x0040
#define DDS_DATA_ON_READERS_STATUS            0x0080
#define DDS_DATA_AVAILABLE_STATUS             0x0100
#define DDS_LIVELINESS_LOST_STATUS            0x0200
#define DDS_LIVELINESS_CHANGED_STATUS         0x0400
#define DDS_PUBLICATION_MATCHED_STATUS        0x0800
#define DDS_SUBSCRIPTION_MATCHED_STATUS       0x1000
#define DDS_ALL_STATUS                        0xFFFF

  /***********************************************************
   *     SampleInfo                                          *
   ***********************************************************/
  typedef struct DDS_SampleInfo 
  {
    DDS_SampleStateKind     sample_state; 
    DDS_ViewStateKind       view_state;   
    DDS_InstanceStateKind   instance_state; 
    DDS_Time_t              source_timestamp; 
    DDS_Time_t              reception_timestamp; 
    DDS_InstanceHandle_t    instance_handle;  
    DDS_InstanceHandle_t    publication_handle;
    int                     disposed_generation_count; 
    int                     no_writers_generation_count;
    int                     sample_rank;
    int                     generation_rank;
    int                     absolute_generation_rank;
    unsigned char           valid_data;
  } DDS_SampleInfo ;

  
  /***********************************************************
   *     STATUS types                                        *
   ***********************************************************/
  typedef struct DDS_InconsistentTopicStatus
  {
    int     total_count;           
    int     total_count_change;    
    char    last_inconsistent_topic_msg[256];     
  } DDS_InconsistentTopicStatus;

  typedef struct DDS_SampleLostStatus
  {
    int     total_count;           
    int     total_count_change;    
  } DDS_SampleLostStatus;          

  typedef enum DDS_SampleRejectedStatusKind
    {
      DDS_NOT_REJECTED,
      DDS_REJECTED_BY_INSTANCE_LIMIT,
      DDS_REJECTED_BY_SAMPLES_LIMIT,
      DDS_REJECTED_BY_SAMPLES_PER_INSTANCE_LIMIT
    } DDS_SampleRejectedStatusKind;

  typedef struct DDS_SampleRejectedStatus
  {
    int     total_count;                       
    int     total_count_change;                
    DDS_SampleRejectedStatusKind last_reason;  
    DDS_InstanceHandle_t last_instance_handle; 
  } DDS_SampleRejectedStatus;

  typedef struct DDS_LivelinessLostStatus
  { 
    int     total_count;             
    int     total_count_change;      
  } DDS_LivelinessLostStatus;

  typedef struct DDS_LivelinessChangedStatus
  {
    int     alive_count;                 
    int     not_alive_count;             
    int     alive_count_change;          
    int     not_alive_count_change;      
    DDS_InstanceHandle_t last_publication_handle; 
  } DDS_LivelinessChangedStatus;

  typedef struct DDS_OfferedDeadlineMissedStatus
  {
    int     total_count;           
    int     total_count_change;    
    DDS_InstanceHandle_t last_instance_handle; 
  } DDS_OfferedDeadlineMissedStatus;
  typedef struct DDS_RequestedDeadlineMissedStatus
  {
    int     total_count;         
    int     total_count_change;  
    DDS_InstanceHandle_t last_instance_handle; 
  } DDS_RequestedDeadlineMissedStatus;

  typedef struct DDS_QosPolicyCount {
    DDS_QosPolicyId_t policy_id;  
    int     count;                
  } DDS_QosPolicyCount;

  DECLARE_SEQ(DDS_QosPolicyCount*, DDS_QosPolicyCountSeq);

  typedef struct DDS_OfferedIncompatibleQosStatus 
  {
    int     total_count;            
    int     total_count_change;     
    DDS_QosPolicyId_t last_policy_id;  
    DDS_QosPolicyCountSeq policies;    
  } DDS_OfferedIncompatibleQosStatus; 

  typedef struct DDS_RequestedIncompatibleQosStatus
  {
    int     total_count;                
    int     total_count_change;         
    DDS_QosPolicyId_t last_policy_id;   
    DDS_QosPolicyCountSeq policies;     
  } DDS_RequestedIncompatibleQosStatus; 

  typedef struct DDS_PublicationMatchedStatus
  {
    int     total_count;           
    int     total_count_change;    
    int     current_count;         
    int     current_count_change;  
    DDS_InstanceHandle_t last_subscription_handle;  
  } DDS_PublicationMatchedStatus;

  typedef struct DDS_SubscriptionMatchedStatus
  {
    int     total_count;           
    int     total_count_change;    
    int     current_count;         
    int     current_count_change;  
    DDS_InstanceHandle_t last_publication_handle;  
  } DDS_SubscriptionMatchedStatus;

  /***********************************************************
   *            Common Sequence Types                        *
   ***********************************************************/

  DECLARE_SEQ( DDS_SampleInfo *,       DDS_SampleInfoSeq );
  DECLARE_SEQ( short,                  DDS_ShortSeq);
  DECLARE_SEQ( void *,                 DDS_PointerSeq);
  DECLARE_SEQ( char *,                 DDS_StringSeq);
  DECLARE_SEQ( unsigned char,          DDS_OctetSeq);

  COREDX_C_API DDS_SampleInfoSeq     * DDS_SampleInfoSeq__alloc(void);
  COREDX_C_API DDS_PointerSeq        * DDS_PointerSeq__alloc(void);
 

  typedef struct DDS_CacheStatistics 
  {
    int32_t           instance_count;            
    int32_t           instance_alive_count;      
    int32_t           instance_disposed_count;   
    int32_t           instance_no_writers_count; 
    int32_t           instance_new_count;        
    int32_t           sample_count;              
    int32_t           sample_read_count;         
    uint32_t          state_flags;               
  } DDS_CacheStatistics;

  COREDX_C_API DDS_ReturnCode_t CoreDX_DDS_heap_init(void * heap_ptr, uint32_t size);

  /* Memory allocation routines that use the same heap as used by the CoreDX %DDS middleware.
   * On some platforms this is simply the libC provided malloc system, on other platforms
   * this is a specialized memory management system provided by CoreDX %DDS.
   */
  COREDX_C_API void *           CoreDX_DDS_malloc(uint32_t size);
  COREDX_C_API void *           CoreDX_DDS_calloc(uint32_t nmemb, uint32_t size);
  COREDX_C_API void             CoreDX_DDS_free(void * ptr);



  /***********************************************************************/
  /* Data types supporting field access by the ContentFilter engine      */
  struct _TypeSupport;
  struct CoreDX_FieldDef;
  typedef void *(*CoreDX_fdef_access)(struct _TypeSupport *, const char *field_name, struct CoreDX_FieldDef *def, const void *data);
  typedef void  (*CoreDX_fdef_clear)(struct CoreDX_FieldDef *def);
  typedef struct CoreDX_FieldDef
  {
    unsigned char          key;
    unsigned char          kind;       /* high bit indicates pointer */
    unsigned char          elem_kind;  /* for array */
    int                    elem_count; /* for array */
    CoreDX_fdef_access     access;
    CoreDX_fdef_clear      clear;
    void                 * user;
    uint32_t               offset;
  } CoreDX_FieldDef_t;

  DECLARE_SEQ(unsigned int, CoreDX_FieldDef_OffsetTable);

  COREDX_C_API void *CoreDX_fielddef_access(struct _TypeSupport *ts, 
                               const char *field_name, 
                               struct CoreDX_FieldDef *def, 
                               const void *data);
  COREDX_C_API void CoreDX_fielddef_clear(struct CoreDX_FieldDef *def);


#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif