/*
 * Copyright (c) 2025 Real-Time Innovations, Inc. All rights reserved.
 * No duplications, whole or partial, manual or electronic, may be made
 * without express written permission.  Any such copies, or revisions thereof,
 * must display this notice unaltered.
 * This code contains trade secrets of Real-Time Innovations, Inc.
 */

#ifndef commend_common_h
#define commend_common_h


#ifndef osapi_type_h
  #include "osapi/osapi_type.h"
#endif

#ifndef commend_dll_h
  #include "commend/commend_dll.h"
#endif

#ifdef __cplusplus
extern "C" {
#endif

/* Doxygen file-level documentation =====================================*/
/*e \file
    \brief COMMEND common definition

*/

/*e \defgroup COMMENDCommonModule COMMENDCommon
  \ingroup COMMENDModule
*/

/* ----------------------------------------------------------------- */
/* QOS */

/*e \defgroup COMMENDQosModule QOS
  \ingroup COMMENDCommonModule
*/

/*e \ingroup COMMENDCommonModule
 * Maximum number of application ip addresses.
 */
#define COMMEND_COMMON_APP_IPADDRESS_COUNT_MAX \
    (RTI_NETIO_RTPS_LOCATOR_LIST_MAX_SIZE)
#define COMMEND_COMMON_APP_IPADDRESS_REDUCED_COUNT_MAX \
    (RTI_NETIO_RTPS_LOCATOR_REDUCED_LIST_MAX_SIZE)

#define COMMEND_COMMON_WR_LIST_DEFAULT \
    { \
        REDA_WEAK_REFERENCE_INVALID, REDA_WEAK_REFERENCE_INVALID, \
                REDA_WEAK_REFERENCE_INVALID, REDA_WEAK_REFERENCE_INVALID, \
                REDA_WEAK_REFERENCE_INVALID, REDA_WEAK_REFERENCE_INVALID, \
                REDA_WEAK_REFERENCE_INVALID, REDA_WEAK_REFERENCE_INVALID, \
                REDA_WEAK_REFERENCE_INVALID, REDA_WEAK_REFERENCE_INVALID, \
                REDA_WEAK_REFERENCE_INVALID, REDA_WEAK_REFERENCE_INVALID, \
                REDA_WEAK_REFERENCE_INVALID, REDA_WEAK_REFERENCE_INVALID, \
                REDA_WEAK_REFERENCE_INVALID, REDA_WEAK_REFERENCE_INVALID \
    }

#define COMMEND_COMMON_WR_REDUCED_LIST_DEFAULT \
    { \
        REDA_WEAK_REFERENCE_INVALID, REDA_WEAK_REFERENCE_INVALID, \
                REDA_WEAK_REFERENCE_INVALID, REDA_WEAK_REFERENCE_INVALID \
    }


#define COMMENDFilterSignature_bit(__signature) (0x80000000 >> (__signature))

/*e \ingroup COMMENDQosModule
 * Auto length used to automatically resolve the receiver_pool.buffer_size
 */
#define COMMEND_LENGTH_AUTO -2

extern COMMENDDllExport int COMMEND_calculateAppendedSize(
        int testType,
        int suffixSize,
        int suffixAlignment);

extern COMMENDDllExport int COMMEND_calculateAppendedAlignment(
        int testType,
        int suffixSize,
        int suffixAlignment);

extern COMMENDDllExport void *COMMEND_calculateAppendedPtr(
        void *entityPtr,
        int testType,
        int suffixSize,
        int suffixAlignment);

typedef enum {
    COMMEND_PROTOCOL_ACK_MODE,
    COMMEND_AUTO_APP_ACK_MODE,
    COMMEND_ORDERED_APP_ACK_MODE,
    COMMEND_EXPLICIT_APP_ACK_MODE
} COMMENDAppAckMode;

typedef enum {
    COMMEND_SEND_WINDOW_RESIZE_PUSH_PULL_RATIO_MODE,
    COMMEND_SEND_WINDOW_RESIZE_NACK_MODE
} COMMENDSendWindowResizeMode;


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

#include "commend/commend_common_impl.h"

#endif /* commend_common_h */