transport_udpv4.h

/*
 * (c) Copyright, Real-Time Innovations, 2005-2024.
 * 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 transport_udpv4_h
#define transport_udpv4_h
 
#include "transport/transport_udp.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define NDDS_Transport_UDPv4 NDDS_Transport_UDP
 
#define NDDS_Transport_UDPv4_InterfaceListener \
  NDDS_Transport_UDP_InterfaceListener
 
/* ================================================================= */
/*                 Component: UDP/IPv4 Transport Plugin              */
/* ================================================================= */
 
/*e \dref_UDPv4TransportBuiltinGroupDocs
 */
 
/*i \file
 * \ingroup NDDS_Transport_UDPv4_Plugin
 * \brief UDPv4 Transport Plugin interfaces and definitions.
 */
 
/* ================================================================= */
/*                 UDPv4 Transport Properties                        */
/* ================================================================= */
 
#ifdef DOXYGEN_DOCUMENTATION_ONLY
/*e \dref_UDPv4Transport_Property_t
 */
struct NDDS_Transport_UDPv4_Property_t {
    /*e \dref_UDPv4Transport_Property_t_parent */
    struct NDDS_Transport_Property_t parent;
 
    /*e \dref_UDPv4Transport_Property_t_send_socket_buffer_size */
    RTI_INT32 send_socket_buffer_size;
 
    /*e \dref_UDPv4Transport_Property_t_recv_socket_buffer_size */
    RTI_INT32 recv_socket_buffer_size;
 
    /*e \dref_UDPv4Transport_Property_t_unicast_enabled */
    RTI_INT32 unicast_enabled;
 
    /*e \dref_UDPv4Transport_Property_t_multicast_enabled */
    RTI_INT32 multicast_enabled;
 
    /*e \dref_UDPv4Transport_Property_t_multicast_ttl */
    RTI_INT32 multicast_ttl;
 
    /*e \dref_UDPv4Transport_Property_t_multicast_loopback_disabled */
    RTI_INT32 multicast_loopback_disabled;
 
    /*e \dref_UDPv4Transport_Property_t_ignore_loopback_interface */
    RTI_INT32 ignore_loopback_interface;
 
    /*e \dref_UDPv4Transport_Property_t_ignore_nonup_interfaces */
    RTI_INT32 ignore_nonup_interfaces;
 
    /*e \dref_UDPv4Transport_Property_t_ignore_nonrunning_interfaces */
    RTI_INT32 ignore_nonrunning_interfaces;
 
    /*e \dref_UDPv4Transport_Property_t_no_zero_copy */
    RTI_INT32 no_zero_copy;
 
    /*e \dref_UDPv4Transport_Property_t_send_blocking */
    RTI_INT32 send_blocking;
 
    /*e \dref_UDPv4Transport_Property_t_use_checksum */
    RTI_INT32 use_checksum;
 
    /*e \dref_UDPv4Transport_Property_t_transport_priority_mask */
    RTI_UINT32 transport_priority_mask;
 
    /*e \dref_UDPv4Transport_Property_t_transport_priority_mapping_low */
    RTI_INT32 transport_priority_mapping_low;
 
    /*e \dref_UDPv4Transport_Property_t_transport_priority_mapping_high */
    RTI_INT32 transport_priority_mapping_high;
 
    /*e \dref_UDPv4Transport_Property_t_send_ping */
    RTI_INT32 send_ping;
 
    /*e \dref_UDPv4Transport_Property_t_force_interface_poll_detection */
    RTI_INT32 force_interface_poll_detection;
 
    /*e \dref_UDPv4Transport_Property_t_interface_poll_period */
    RTI_UINT32 interface_poll_period;
 
    /*e \dref_UDPv4Transport_Property_t_reuse_multicast_receive_resource */
    RTI_INT32 reuse_multicast_receive_resource;
 
    /*e \dref_UDPv4Transport_Property_t_protocol_overhead_max */
    RTI_INT32 protocol_overhead_max;
 
    /*e \dref_UDPv4Transport_Property_t_disable_interface_tracking */
    RTI_INT32 disable_interface_tracking;
 
    /*e \dref_UDPv4Transport_Property_t_join_multicast_group_timeout */
    RTI_UINT32 join_multicast_group_timeout;
 
    /*e \dref_UDPv4Transport_Property_t_public_address */
    char *public_address;
 
    /*e \dref_UDPv4Transport_Property_t_port_offset */
    RTI_INT32 port_offset;
};
#endif
 
/* ================================================================= */
/*                 Component: UDP/IPv4  WAN Transport Plugin         */
/* ================================================================= */
 
/*e \dref_UDPv4WanTransportBuiltinGroupDocs */
 
/*i \file
 * \ingroup NDDS_Transport_UDPv4_WAN_Plugin
 * \brief UDPv4 WAN Transport Plugin interfaces and definitions.
 */
 
/* ================================================================= */
/*                 UDPv4 WAN Transport Properties                    */
/* ================================================================= */
 
#ifdef DOXYGEN_DOCUMENTATION_ONLY
/*e \dref_UDPv4_WAN_Transport_Property_t
 */
struct NDDS_Transport_UDPv4_WAN_Property_t {
    /*e \dref_UDPv4_WAN_Transport_Property_t_parent */
    struct NDDS_Transport_Property_t parent;
 
    /*e \dref_UDPv4_WAN_Transport_Property_t_send_socket_buffer_size */
    RTI_INT32 send_socket_buffer_size;
 
    /*e \dref_UDPv4_WAN_Transport_Property_t_recv_socket_buffer_size */
    RTI_INT32 recv_socket_buffer_size;
 
    /*e \dref_UDPv4_WAN_Transport_Property_t_ignore_loopback_interface */
    RTI_INT32 ignore_loopback_interface;
 
    /*e \dref_UDPv4_WAN_Transport_Property_t_ignore_nonup_interfaces */
    RTI_INT32 ignore_nonup_interfaces;
 
    /*e \dref_UDPv4_WAN_Transport_Property_t_ignore_nonrunning_interfaces */
    RTI_INT32 ignore_nonrunning_interfaces;
 
    /*e \dref_UDPv4_WAN_Transport_Property_t_no_zero_copy */
    RTI_INT32 no_zero_copy;
 
    /*e \dref_UDPv4_WAN_Transport_Property_t_send_blocking */
    RTI_INT32 send_blocking;
 
    /*e \dref_UDPv4_WAN_Transport_Property_t_use_checksum */
    RTI_INT32 use_checksum;
 
    /*e \dref_UDPv4_WAN_Transport_Property_t_transport_priority_mask */
    RTI_UINT32 transport_priority_mask;
 
    /*e \dref_UDPv4_WAN_Transport_Property_t_transport_priority_mapping_low */
    RTI_INT32 transport_priority_mapping_low;
 
    /*e \dref_UDPv4_WAN_Transport_Property_t_transport_priority_mapping_high */
    RTI_INT32 transport_priority_mapping_high;
 
    /*e \dref_UDPv4_WAN_Transport_Property_t_send_ping */
    RTI_INT32 send_ping;
 
    /*e \dref_UDPv4_WAN_Transport_Property_t_force_interface_poll_detection */
    RTI_INT32 force_interface_poll_detection;
 
    /*e \dref_UDPv4_WAN_Transport_Property_t_interface_poll_period */
    RTI_UINT32 interface_poll_period;
 
    /*e \dref_UDPv4_WAN_Transport_Property_t_protocol_overhead_max */
    RTI_INT32 protocol_overhead_max;
 
    /*e \dref_UDPv4_WAN_Transport_Property_t_disable_interface_tracking */
    RTI_INT32 disable_interface_tracking;
 
    /*e \dref_UDPv4_WAN_Transport_Property_t_public_address */
    char *public_address;
 
    /*e \dref_UDPv4_WAN_Transport_Property_t_comm_ports_list */
    struct NDDS_Transport_UDP_WAN_CommPortsMappingInfo *comm_ports_list;
 
    /*e \dref_UDPv4_WAN_Transport_Property_t_comm_ports_list_length */
    RTI_INT32 comm_ports_list_length;
 
    /*e \dref_UDPv4_WAN_Transport_Property_t_port_offset */
    RTI_INT32 port_offset;
 
    /*e \dref_UDPv4_WAN_Transport_Property_t_binding_ping_period */
    RTI_UINT32 binding_ping_period;
};
#endif
 
#define NDDS_Transport_UDPv4_Property_t NDDS_Transport_UDP_Property_t
#define NDDS_Transport_UDPv4_WAN_Property_t NDDS_Transport_UDP_Property_t
 
/*i \ingroup NDDS_Transport_UDPv4_Plugin
 * \brief UDPv4 plugin class string name
 */
#define NDDS_TRANSPORT_UDPV4_CLASS_NAME "udpv4"
 
/*i \ingroup NDDS_Transport_UDPv4_Plugin
 * \brief UDPv4 plugin class string name
 */
#define NDDS_TRANSPORT_UDPV4_WAN_CLASS_NAME "udpv4_wan"
 
/*i \ingroup NDDS_Transport_UDPv4_Plugin
 * \brief UDPv4 builtin plugin alias
 */
#define NDDS_TRANSPORT_BUILTIN_UDPV4_ALIAS "builtin.udpv4"
 
/*i \ingroup NDDS_Transport_UDPv4_Plugin
 * \brief UDPv4 builtin plugin alias
 */
#define NDDS_TRANSPORT_BUILTIN_UDPV4_WAN_ALIAS "builtin.udpv4_wan"
 
/*e \ingroup NDDS_Transport_UDPv4_Plugin
 * \brief Default value of NDDS_Transport_Property_t#address_bit_count
 */
#define NDDS_TRANSPORT_UDPV4_ADDRESS_BIT_COUNT (32)
 
/*e \ingroup NDDS_Transport_UDPv4_Plugin
 * \brief Default value of NDDS_Transport_Property_t#address_bit_count for
 * UDPv4 asymmetric transport
 */
#define NDDS_TRANSPORT_UDPV4_WAN_ADDRESS_BIT_COUNT (128)
 
/*e \ingroup NDDS_Transport_UDPv4_Plugin
 * \brief Default value of NDDS_Transport_Property_t#properties_bitmap.
 */
#define NDDS_TRANSPORT_UDPV4_PROPERTIES_BITMAP_DEFAULT \
    NDDS_TRANSPORT_UDP_PROPERTIES_BITMAP_DEFAULT
 
/*e \ingroup NDDS_Transport_UDPv4_Plugin
 * \brief Default value of
 * NDDS_Transport_Property_t#gather_send_buffer_count_max.
 *
 * This is also the maximum value that can be used when instantiating the UDP
 * transport.
 *
 * 16 is sufficient for \ndds, but more may improve discovery and reliable
 * performance.
 * Porting note: find out what the maximum gather buffer count is on your OS!
 */
#define NDDS_TRANSPORT_UDPV4_GATHER_SEND_BUFFER_COUNT_MAX_DEFAULT \
    NDDS_TRANSPORT_UDP_GATHER_SEND_BUFFER_COUNT_MAX_DEFAULT
 
/*e \dref_UDPv4Transport_SOCKET_BUFFER_SIZE_OS_MAX
 */
#define NDDS_TRANSPORT_UDPV4_SOCKET_BUFFER_SIZE_OS_MAX \
    NDDS_TRANSPORT_UDP_SOCKET_BUFFER_SIZE_OS_MAX
 
/*e \dref_UDPv4Transport_SOCKET_BUFFER_SIZE_OS_DEFAULT
 */
#define NDDS_TRANSPORT_UDPV4_SOCKET_BUFFER_SIZE_OS_DEFAULT \
    NDDS_TRANSPORT_UDP_SOCKET_BUFFER_SIZE_OS_DEFAULT
 
/*e \dref_UDPv4Transport_SEND_SOCKET_BUFFER_SIZE_DEFAULT
 */
#define NDDS_TRANSPORT_UDPV4_SEND_SOCKET_BUFFER_SIZE_DEFAULT \
    NDDS_TRANSPORT_UDP_SEND_SOCKET_BUFFER_SIZE_DEFAULT
 
/*e \dref_UDPv4Transport_RECV_SOCKET_BUFFER_SIZE_DEFAULT
 */
#define NDDS_TRANSPORT_UDPV4_RECV_SOCKET_BUFFER_SIZE_DEFAULT \
    NDDS_TRANSPORT_UDP_RECV_SOCKET_BUFFER_SIZE_DEFAULT
 
/*e \ingroup NDDS_Transport_UDPv4_Plugin
 * \brief Maximum value of NDDS_Transport_Property_t#message_size_max.
 */
#define NDDS_TRANSPORT_UDPV4_PAYLOAD_SIZE_MAX (65507)
 
/*e \ingroup NDDS_Transport_UDPv4_Plugin
 * \brief Maximum value of NDDS_Transport_Property_t#message_size_max.
 */
#if defined(RTI_INTY)
  #define NDDS_TRANSPORT_UDPV4_MESSAGE_SIZE_MAX_DEFAULT (9216)
#else
  #define NDDS_TRANSPORT_UDPV4_MESSAGE_SIZE_MAX_DEFAULT \
    NDDS_TRANSPORT_UDPV4_PAYLOAD_SIZE_MAX
#endif
 
/*e \ingroup NDDS_Transport_UDPv4_WAN_Plugin
 * \brief Maximum value of NDDS_Transport_Property_t#message_size_max.
 */
#define NDDS_TRANSPORT_UDPV4_WAN_MESSAGE_SIZE_MAX_DEFAULT (1400)
 
#define NDDS_TRANSPORT_UDPV4_DATAGRAM_LENGTH_MAX \
  NDDS_TRANSPORT_UDP_DATAGRAM_LENGTH_MAX
 
/*e \ingroup NDDS_Transport_UDPv4_Plugin
 * \brief Default value of NDDS_Transport_UDPv4_Property_t#multicast_ttl.
 */
#define NDDS_TRANSPORT_UDPV4_MULTICAST_TTL_DEFAULT \
  NDDS_TRANSPORT_UDP_MULTICAST_TTL_DEFAULT
 
 
#define NDDS_TRANSPORT_UDPV4_USE_MULTICAST_DEFAULT \
  NDDS_TRANSPORT_UDP_USE_MULTICAST_DEFAULT
 
 
/*e \dref_UDPv4Transport_IGNORE_LOOPBACK_DISABLED
 */
#define NDDS_TRANSPORT_UDPV4_IGNORE_LOOPBACK_DISABLED \
  NDDS_TRANSPORT_UDP_IGNORE_LOOPBACK_DISABLED
 
/*e \dref_UDPv4Transport_IGNORE_LOOPBACK_ENABLED
 */
#define NDDS_TRANSPORT_UDPV4_IGNORE_LOOPBACK_ENABLED \
  NDDS_TRANSPORT_UDP_IGNORE_LOOPBACK_ENABLED
 
/*e \dref_UDPv4Transport_IGNORE_LOOPBACK_AUTO
 */
#define NDDS_TRANSPORT_UDPV4_IGNORE_LOOPBACK_AUTO \
  NDDS_TRANSPORT_UDP_IGNORE_LOOPBACK_AUTO
 
 
/*e \dref_UDPv4Transport_USE_CHECKSUM_DISABLED
 */
#define NDDS_TRANSPORT_UDPV4_USE_CHECKSUM_DISABLED (0)
 
/*e \dref_UDPv4Transport_USE_CHECKSUM_ENABLED
 */
#define NDDS_TRANSPORT_UDPV4_USE_CHECKSUM_ENABLED (1)
 
 
/*e \dref_UDPv4Transport_BLOCKING_NEVER
 */
#define NDDS_TRANSPORT_UDPV4_BLOCKING_NEVER NDDS_TRANSPORT_UDP_BLOCKING_NEVER
 
/*e \dref_UDPv4Transport_BLOCKING_ALWAYS
 */
#define NDDS_TRANSPORT_UDPV4_BLOCKING_ALWAYS NDDS_TRANSPORT_UDP_BLOCKING_ALWAYS
#define NDDS_TRANSPORT_UDPV4_BLOCKING_UNICAST_ONLY \
  NDDS_TRANSPORT_UDP_BLOCKING_UNICAST_ONLY
 
/*e \dref_UDPv4Transport_BLOCKING_DEFAULT
 */
#define NDDS_TRANSPORT_UDPV4_BLOCKING_DEFAULT \
  NDDS_TRANSPORT_UDP_BLOCKING_DEFAULT
 
/*e \ingroup NDDS_Transport_UDPv4_Plugin
 * \brief Use this to initialize a NDDS_Transport_UDPv4_Property_t structure.
 */
#define NDDS_TRANSPORT_UDPV4_PROPERTY_DEFAULT \
    { \
        { \
            NDDS_TRANSPORT_CLASSID_UDPv4, \
            NDDS_TRANSPORT_UDPV4_ADDRESS_BIT_COUNT, \
            NDDS_TRANSPORT_UDPV4_PROPERTIES_BITMAP_DEFAULT, \
            NDDS_TRANSPORT_UDPV4_GATHER_SEND_BUFFER_COUNT_MAX_DEFAULT, \
            NDDS_TRANSPORT_UDPV4_MESSAGE_SIZE_MAX_DEFAULT, \
            NULL, \
            0, /* allow_interfaces_list */ \
            NULL, \
            0, /* deny_interfaces_list */ \
            NULL, \
            0, /* allow_multicast_interfaces_list */ \
            NULL, \
            0,                           /* deny_multicast_interfaces_list */ \
            NDDS_TRANSPORT_UUID_UNKNOWN, /* transport_uuid */ \
            NULL,                        /* domain_participant_ptr */ \
            NULL,                        /* domain_participant_forwarder */ \
            NULL,                        /* thread_name_prefix */ \
            NDDS_TRANSPORT_LENGTH_UNLIMITED, /* max_interface_count */ \
        }, \
                NDDS_TRANSPORT_UDPV4_SEND_SOCKET_BUFFER_SIZE_DEFAULT, \
                NDDS_TRANSPORT_UDPV4_RECV_SOCKET_BUFFER_SIZE_DEFAULT, \
                1,                                          /* unicast_enabled \
                                                             */ \
                NDDS_TRANSPORT_UDPV4_USE_MULTICAST_DEFAULT, /* multicast_enabled \
                                                             */ \
                NDDS_TRANSPORT_UDPV4_MULTICAST_TTL_DEFAULT, 0, /* multicast \
                                                                  loopback \
                                                                  enabled */ \
                NDDS_TRANSPORT_UDPV4_IGNORE_LOOPBACK_AUTO, /* (auto-)ignore \
                                                              loopback */ \
                1, /* ignore_nonup_interfaces */ \
                1, /* ignore_nonrunning_interfaces */ \
                0, /* no_zero_copy */ \
                NDDS_TRANSPORT_UDPV4_BLOCKING_DEFAULT, 0,  /* enable_v4mapped \
                                                            */ \
                NDDS_TRANSPORT_UDPV4_USE_CHECKSUM_ENABLED, /* use_checksum */ \
                0, 0, 0xff /* no mapping to IP_TOS by default */, \
                1,    /* send_ping \
                       */ \
                0,    /* don't force polling interface tracker by default */ \
                500,  /* 500 millisecs is the default polling period*/ \
                1,    /* reuse multicast receive resource */ \
                28,   /* protocol_overhead_max (UDP(8)+IP(20)) */ \
                0,    /* disable interface tracking */ \
                5000, /* join_multicast_group_timeout */ \
                NULL, /* public_address */ \
                NULL, 0,   /* comm_ports_list */ \
                NULL,      /* wan_listener */ \
                0,         /* port_offset */ \
                0,         /* binding_ping_period */ \
                0,         /* binding_ping_mapping_expiration */ \
                NULL,      /* plugin_enabled_function_ptr */ \
                RTI_FALSE, /* gather_detailed_statistics */ \
                RTI_FALSE, /* drop_samples_by_guid_prefix */ \
                RTI_OSAPI_RTPS_GUID_PREFIX_UNKNOWN /* guid_prefix_to_drop */ \
    }
 
/*e \ingroup NDDS_Transport_UDPv4_WAN_Plugin
 * \brief Use this to initialize a NDDS_Transport_UDPv4_WAN_Property_t
 * structure.
 */
#define NDDS_TRANSPORT_UDPV4_WAN_PROPERTY_DEFAULT \
    { \
        { \
            NDDS_TRANSPORT_CLASSID_UDPv4_WAN, \
            NDDS_TRANSPORT_UDPV4_WAN_ADDRESS_BIT_COUNT, \
            NDDS_TRANSPORT_UDPV4_PROPERTIES_BITMAP_DEFAULT, \
            NDDS_TRANSPORT_UDPV4_GATHER_SEND_BUFFER_COUNT_MAX_DEFAULT, \
            NDDS_TRANSPORT_UDPV4_WAN_MESSAGE_SIZE_MAX_DEFAULT, \
            NULL, \
            0, /* allow_interfaces_list */ \
            NULL, \
            0, /* deny_interfaces_list */ \
            NULL, \
            0, /* allow_multicast_interfaces_list */ \
            NULL, \
            0,                           /* deny_multicast_interfaces_list */ \
            NDDS_TRANSPORT_UUID_UNKNOWN, /* transport_uuid */ \
            NULL,                        /* domain_participant_ptr */ \
            NULL,                        /* domain_participant_forwarder */ \
            NULL,                        /* thread_name_prefix */ \
            NDDS_TRANSPORT_LENGTH_UNLIMITED, /* max_interface_count */ \
        }, \
                NDDS_TRANSPORT_UDPV4_SEND_SOCKET_BUFFER_SIZE_DEFAULT, \
                NDDS_TRANSPORT_UDPV4_RECV_SOCKET_BUFFER_SIZE_DEFAULT, \
                1, /* unicast_enabled \
                    */ \
                0, /* multicast_enabled */ \
                NDDS_TRANSPORT_UDPV4_MULTICAST_TTL_DEFAULT, 0, /* multicast \
                                                                  loopback \
                                                                  enabled */ \
                NDDS_TRANSPORT_UDPV4_IGNORE_LOOPBACK_AUTO, /* (auto-)ignore \
                                                              loopback */ \
                1, /* ignore_nonup_interfaces */ \
                1, /* ignore_nonrunning_interfaces */ \
                0, /* no_zero_copy */ \
                NDDS_TRANSPORT_UDPV4_BLOCKING_DEFAULT, 0,  /* enable_v4mapped \
                                                            */ \
                NDDS_TRANSPORT_UDPV4_USE_CHECKSUM_ENABLED, /* use_checksum */ \
                0, 0, 0xff /* no mapping to IP_TOS by default */, \
                1,    /* send_ping \
                       */ \
                0,    /* don't force polling interface tracker by default */ \
                500,  /* 500 millisecs is the default polling period*/ \
                1,    /* reuse multicast receive resource */ \
                28,   /* protocol_overhead_max (UDP(8)+IP(20)) */ \
                0,    /* disable interface tracking */ \
                5000, /* join_multicast_group_timeout */ \
                NULL, /* public_address */ \
                NULL, 0,   /* comm_ports_list */ \
                NULL,      /* wan_listener */ \
                125,       /* port_offset */ \
                1000,      /* binding_ping_period */ \
                0,         /* binding_ping_mapping_expiration */ \
                NULL,      /* plugin_enabled_function_ptr */ \
                RTI_FALSE, /* gather_detailed_statistics */ \
                RTI_FALSE, /* drop_samples_by_guid_prefix */ \
                RTI_OSAPI_RTPS_GUID_PREFIX_UNKNOWN /* guid_prefix_to_drop */ \
    }
 
/* ================================================================= */
/*                   InterfaceListener Class                         */
/* ================================================================= */
 
/*i
 * \defgroup NDDS_Transport_UDP_InterfaceListenerClass
 * NDDS_Transport_UDP_InterfaceListener \ingroup NDDS_Transport_UDP_Plugin
 * \brief Interface for IPv4 interface acceptance/rejection
 *
 * @mtsafety See NDDS_Transport_UDP_public UML diagram
 *
 * @see NDDS_Transport_UDPv4_newI
 */
#define NDDS_Transport_UDPv4_InterfaceListener \
  NDDS_Transport_UDP_InterfaceListener
 
/*i \ingroup NDDS_Transport_UDPv4_InterfaceListenerClass
 * \brief A user-provided function to be used to filter out particular
 * network interfaces to be used by the Transport Plugin.
 *
 * The user may implement this function and pass it to an
 * instance of an UDPv4 Transport Plugin to reject or accept network
 * interfaces that the plugin offers as ones to use to receive
 * messages.
 *
 * When \ndds contacts other applications, it will provide a list of
 * interfaces that other applications can use to send messages (on a
 * plugin by plugin basis).  The addresses of the interfaces are used
 * as the destination addresses of messages that are sent.  If a plugin
 * rejects one of the available network interfaces, then that interface
 * will not be offered as one to which other plugins should send
 * messages.
 *
 * For interfaces that can be used by the plugin, this function also
 * enables the user to select which interfaces \ndds is allowed to use
 * in sending multicast messages.  The set of interfaces enabled for
 * multicast sending is a subset of the interfaces that can be used for
 * receiving.  That is, an interface cannot be enabled to send
 * multicast messages but disabled for receiving unicast messages.
 *
 * Only IP network interfaces that are "UP" (enabled by the OS and
 * ready to use) will be passed to this filter function.  The ones that
 * are "DOWN" will not be used by definition.
 *
 * @param plugin \st_in The instance of the plugin for which the filter
 * is being called.
 *
 * @param multicast_enabled_out \st_out The filter should set whether
 * or not the plugin is allowed to use this interface for
 * sending/receiving multicast messages.
 *
 * @param interface_in \st_in An interface offered by the plugin as a
 * candidate for receive messages.
 *
 * @return 1 to use the interface, 0 to reject using the interface.
 *         \c multicast_enabled_out will indicate whether it is also OK
 *         to use the interface to send multicast messages.
 */
#define NDDS_Transport_UDPv4_Interface_Filter_Fcn \
  NDDS_Transport_UDP_Interface_Filter_Fcn
 
/* ================================================================= */
/*                    UDPv4/IPv4 InterfaceListener                   */
/* ================================================================= */
 
 
/*i \ingroup NDDS_Transport_UDPv4_InterfaceListenerClass
 * \brief Default implementation of the Interface listener.
 *
 * The default interface listener applies the interface selection preferences
 * specified in the NDDS_Transport_UDP_Property_t#parent:
 * - NDDS_Transport_Property_t#allow_interfaces_list,
 * - NDDS_Transport_Property_t#deny_interfaces_list,
 * - NDDS_Transport_Property_t#allow_multicast_interfaces_list,
 * - NDDS_Transport_Property_t#deny_multicast_interfaces_list
 *
 * The filter assumes that the strings passed in the address filter
 * are in UDPv4 dot notation, possibly containing wildcards. For example:
 *        10.10.30.232
 *        10.10.*.*
 *        192.168.1.*
 * etc.
 *
 * @see NDDS_Transport_UDP_Interface_Filter_Fcn
 */
extern NDDS_Transport_DllExport RTI_INT32
NDDS_Transport_UDPv4_InterfaceListener_onInterface(
        struct NDDS_Transport_UDPv4_InterfaceListener *self,
        struct NDDS_Transport_UDPv4 *plugin,
        RTI_INT32 *multicast_enabled_out,
        NDDS_Transport_Interface_t *interface_in,
        const char *interface_name_in);
 
/*i \ingroup NDDS_Transport_UDPv4_InterfaceListenerClass
 * \brief Default interface listener.
 */
extern NDDS_Transport_DllVariable struct NDDS_Transport_UDP_InterfaceListener
        NDDS_Transport_UDPv4_g_interfaceListener;
 
/* ================================================================= */
/*                   Socket Factory Class                            */
/* ================================================================= */
/*i
 * \defgroup NDDS_Transport_UDP_SocketFactoryClass
 * NDDS_Transport_UDP_SocketFactory \ingroup NDDS_Transport_UDPv4_Plugin \brief
 * Interface for IPv4 socket creation and destruction.
 *
 * @mtsafety See NDDS_Transport_UDPv4_public UML diagram
 *
 * @see NDDS_Transport_UDPv4_new
 */
 
#define NDDS_Transport_UDPv4_SocketFactory_Send_Socket_Create_Fcn \
  NDDS_Transport_UDP_SocketFactory_Send_Socket_Create_Fcn
 
 
#define NDDS_Transport_UDPv4_SocketFactory_Receive_Socket_Create_Fcn \
  NDDS_Transport_UDP_SocketFactory_Receive_Socket_Create_Fcn
 
 
#define NDDS_Transport_UDPv4_SocketFactory_Socket_Destroy_Fcn \
  NDDS_Transport_UDP_SocketFactory_Socket_Destroy_Fcn
 
 
#define NDDS_Transport_UDPv4_SocketFactory NDDS_Transport_UDP_SocketFactory
 
 
#define NDDS_Transport_UDPv4_SocketFactory_is_valid \
  NDDS_Transport_UDP_SocketFactory_is_valid
 
/* ================================================================= */
/*                 IP Socket Factory Class                           */
/* ================================================================= */
 
/*i \ingroup NDDS_Transport_UDP_SocketFactoryClass
 * \brief Default implementation of the socket creation factory method
 * for UDPv4 transport.
 *
 * @post Sending socket is not bound.
 *
 * @see NDDS_Transport_UDP_SocketFactory_Send_Socket_Create_Fcn
 */
extern NDDS_Transport_DllExport RTI_INT32
NDDS_Transport_UDPv4_SocketFactory_create_send_socket(
        struct NDDS_Transport_UDPv4_SocketFactory *me,
        NDDS_Transport_Port_t *port_out,
        const struct NDDS_Transport_UDPv4 *ip_in,
        const NDDS_Transport_Address_t *interface_address_in,
        const int *interface_index_in);
 
/*i \ingroup NDDS_Transport_UDP_SocketFactoryClass
 * \brief Default implementation of the socket creation factory method.
 *
 * @post socket is created and bound
 *
 * @see NDDS_Transport_UDP_SocketFactory_Receive_Socket_Create_Fcn
 */
extern NDDS_Transport_DllExport RTI_INT32
NDDS_Transport_UDPv4_SocketFactory_create_receive_socket(
        struct NDDS_Transport_UDPv4_SocketFactory *me,
        NDDS_Transport_Port_t *port_inout,
        const struct NDDS_Transport_UDPv4 *ip_in,
        const NDDS_Transport_Address_t *multicast_address_in);
 
/*i \ingroup NDDS_Transport_UDP_SocketFactoryClass
 * \brief Default implementation of the socket destroy factory method
 * @see NDDS_Transport_UDP_SocketFactory_Socket_Destroy_Fcn
 */
extern NDDS_Transport_DllExport RTI_INT32
NDDS_Transport_UDPv4_SocketFactory_destroy_socket(
        struct NDDS_Transport_UDPv4_SocketFactory *me,
        RTI_INT32 s_in);
 
/*i \ingroup NDDS_Transport_UDP_SocketFactoryClass
 * \brief Used to bind a socket to the desired port
 *
 * @param s_in \b In. socket to be bound
 *
 * @param port_desired_in \b In. port number to bind to, use 0 to be
 * assigned an ephemeral port.
 *
 * @return if successful, the port number bound to or 0 if
 * unsuccessful.
 */
extern NDDS_Transport_DllExport NDDS_Transport_Port_t
NDDS_Transport_UDPv4_Socket_bind(
        RTI_INT32 s_in,
        const NDDS_Transport_Port_t port_desired_in);
 
/*i \ingroup NDDS_Transport_UDP_SocketFactoryClass
 * \brief Used to bind a socket to the desired port with specified IP
 *
 * @param s_in \b In. socket to be bound
 *
 * @param port_desired_in \b In. port number to bind to, use 0 to be
 * assigned an ephemeral port.
 *
 * @param ip_in \b In. IP to bind
 *
 * @return if successful, the port number bound to or 0 if
 * unsuccessful.
 */
extern NDDS_Transport_DllExport NDDS_Transport_Port_t
NDDS_Transport_UDPv4_Socket_bind_with_ip(
        RTI_INT32 s_in,
        const NDDS_Transport_Port_t port_desired_in,
        unsigned int ip_in);
 
/*i \ingroup NDDS_Transport_UDP_SocketFactoryClass
 * \brief Default socket factory.
 */
extern NDDS_Transport_DllVariable struct NDDS_Transport_UDPv4_SocketFactory
        NDDS_Transport_UDPv4_g_socketFactory;
 
/*i \ingroup NDDS_Transport_UDPv4_Plugin
 * \brief Realization of NDDS_Transport_Get_Class_Name_Fcn_cEA for IPv4
 * transports.
 *
 * Returns the string "udpv4".
 *
 * @see NDDS_Transport_Get_Class_Name_Fcn_cEA for complete
 * documentation.
 */
#define NDDS_Transport_UDPv4_get_class_name_cEA \
  NDDS_Transport_UDP_get_class_name_cEA
 
/*e \ingroup NDDS_Transport_UDPv4_Plugin
 * \brief Realization of NDDS_Transport_String_To_Address_Fcn_cEA for IP
 * transports.
 *
 * Converts a host name string to a IPv4 address.
 *
 * @param self  NOT USED. May be NULL.
 *
 * @param address_out \st_out The corresponding numerical value in IPv4
 * format.
 *
 * @param address_in \st_in The name of the IPv4 address. It can be a
 * dot notation name or a host name. If NULL, then the IP address of
 * the localhost will be returned.
 *
 * @see NDDS_Transport_String_To_Address_Fcn_cEA for complete
 * documentation.
 */
#define NDDS_Transport_UDPv4_string_to_address_cEA \
  NDDS_Transport_UDP_string_to_address_cEA
 
/* ================================================================= */
/*                      UDP/IP Transport Plugin                      */
/* ================================================================= */
 
/*e \ingroup NDDS_Transport_UDPv4_Plugin
 * \brief Create an instance of a UDPv4 Transport Plugin.
 *
 * An application may create and register multiple instances of this
 * Transport Plugin with \ndds. Multiple instances of the plugin may be useful
 * for partitioning the network interfaces across multiple \ndds domains.
 * However, note that the underlying transport, the operating system's IP layer,
 * is still a "singleton."  For example, if a unicast transport has already
 * bound to a port, and another unicast transport tries to bind to the same
 * port, the second attempt will fail.
 *
 * The transport plugin honors the interface/multicast "white" and "black"
 * lists specified in the NDDS_Transport_UDP_Property_t#parent:
 * - NDDS_Transport_Property_t#allow_interfaces_list,
 * - NDDS_Transport_Property_t#deny_interfaces_list,
 * - NDDS_Transport_Property_t#allow_multicast_interfaces_list,
 * - NDDS_Transport_Property_t#deny_multicast_interfaces_list
 *
 * The format of a string in these lists is assumed to be in standard IPv4
 * dot notation, possibly containing wildcards. For example:
 *       - 10.10.30.232
 *       - 10.10.*.*
 *       - 192.168.1.*
 *       - etc.
 * Strings not in the correct format will be ignored.
 *
 * @param property_in \st_in Desired behavior of this transport. May be
 * NULL for default property.
 *
 * @return A UDPv4 Transport Plugin instance on success; or NULL on failure.
 */
extern NDDS_Transport_DllExport NDDS_Transport_Plugin *NDDS_Transport_UDPv4_new(
        const struct NDDS_Transport_UDPv4_Property_t *property_in);
 
/*e \ingroup NDDS_Transport_UDPv4_WAN_Plugin
 * @brief Create an instance of a UDPv4_WAN Transport Plugin.
 *
 * An application may create and register multiple instances of this
 * Transport Plugin with \ndds. Multiple instances of the plugin may be useful
 * for partitioning the network interfaces across multiple \ndds domains.
 * However, note that the underlying transport, the operating system's IP layer,
 * is still a "singleton."  For example, if a unicast transport has already
 * bound to a port, and another unicast transport tries to bind to the same
 * port, the second attempt will fail.
 *
 * The transport plugin honors the interface "white" and "black"
 * lists specified in the NDDS_Transport_UDP_Property_t#parent:
 * - NDDS_Transport_Property_t#allow_interfaces_list,
 * - NDDS_Transport_Property_t#deny_interfaces_list,
 *
 * The format of a string in these lists is assumed to be in standard IPv4
 * dot notation, possibly containing wildcards. For example:
 *       - 10.10.30.232
 *       - 10.10.*.*
 *       - 192.168.1.*
 *       - etc.
 * Strings not in the correct format will be ignored.
 *
 * @param property_in \st_in Desired behavior of this transport. May be
 * NULL for default property.
 *
 * @return A UDPv4_WAN Transport Plugin instance on success; or NULL on failure.
 */
extern NDDS_Transport_DllExport NDDS_Transport_Plugin *
NDDS_Transport_UDPv4_WAN_new(
        const struct NDDS_Transport_UDPv4_WAN_Property_t *property_in);
 
/*i \ingroup NDDS_Transport_UDPv4_Plugin
 * \brief Create an instance of a UDPv4 Transport Plugin.
 *
 * \copydoc NDDS_Transport_UDPv4_new
 *
 * @param socket_factory_in \st_in The factory that will create all the
 * sockets to be used in the transport.  May be NULL if default factory
 * is to be used.  Only used by RTI internal testing.
 * End users should set this parameter to NULL.
 *
 * @param interface_filter_in \st_in A function that will be used to
 * filter out network interfaces that this plugin can use. May be NULL if
 * default interface listener is to be used. The default listener uses
 * The NDDS_Transport_UDP_Property_t#parent's lists to select the interfaces.
 * Only used by RTI internal testing. End users should set this
 * parameter to NULL.
 *
 * @exception RTI_LOG_MALLOC_FAILURE_d RTI_LOG_CREATION_FAILURE_s
 * RTI_LOG_PRECONDITION_FAILURE RTI_LOG_INIT_FAILURE_s
 */
extern NDDS_Transport_DllExport NDDS_Transport_Plugin *
NDDS_Transport_UDPv4_newI(
        const struct NDDS_Transport_UDPv4_Property_t *property_in,
        struct NDDS_Transport_UDPv4_SocketFactory *socket_factory_in,
        struct NDDS_Transport_UDPv4_InterfaceListener *interface_listener_in);
 
/*i \ingroup NDDS_Transport_UDPv4_WAN_Plugin
 * @brief Create an instance of a UDPv4_WAN Transport Plugin.
 *
 * \copydoc NDDS_Transport_UDPv4_WAN_new
 *
 * @param socket_factory_in \st_in The factory that will create all the
 * sockets to be used in the transport.  May be NULL if default factory
 * is to be used.  Only used by RTI internal testing.
 * End users should set this parameter to NULL.
 *
 * @param interface_filter_in \st_in A function that will be used to
 * filter out network interfaces that this plugin can use. May be NULL if
 * default interface listener is to be used. The default listener uses
 * The NDDS_Transport_UDP_Property_t#parent's lists to select the interfaces.
 * Only used by RTI internal testing. End users should set this
 * parameter to NULL.
 *
 * @exception RTI_LOG_MALLOC_FAILURE_d RTI_LOG_CREATION_FAILURE_s
 * RTI_LOG_PRECONDITION_FAILURE RTI_LOG_INIT_FAILURE_s
 */
extern NDDS_Transport_DllExport NDDS_Transport_Plugin *
NDDS_Transport_UDPv4_WAN_newI(
        const struct NDDS_Transport_UDPv4_WAN_Property_t *property_in,
        struct NDDS_Transport_UDPv4_SocketFactory *socket_factory_in,
        struct NDDS_Transport_UDPv4_InterfaceListener *interface_listener_in);
 
 
#define NDDS_Transport_UDPv4_get_receive_interfaces_cEA \
  NDDS_Transport_UDP_get_receive_interfaces_cEA
 
 
#define NDDS_Transport_UDPv4_get_ignore_loopback_interface_status \
  NDDS_Transport_UDP_get_ignore_loopback_interface_status
 
 
#define NDDS_Transport_UDPv4_is_local_address \
  NDDS_Transport_UDP_is_local_address
 
 
#define NDDS_Transport_UDPv4_map_transport_priority \
  NDDS_Transport_UDP_map_transport_priority
 
/*i \ingroup NDDS_Transport_UDPv4_Plugin
  \brief Definition of IPv4 local host.
*/
#define NDDS_TRANSPORT_UDPV4_ADDRESS_LOCALHOST \
  { \
    { \
      0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 127, 0, 0, 1 \
    } \
  }
 
 
#define NDDS_TRANSPORT_UDPV4_UNBLOCK_MESSAGE_SIZE \
  NDDS_TRANSPORT_UDP_UNBLOCK_MESSAGE_SIZE
 
 
#define NDDS_Transport_UDPv4_Statistics NDDS_Transport_UDP_Statistics
 
 
#define NDDS_Transport_UDPv4_get_statistics NDDS_Transport_UDP_get_statistics
 
 
#define NDDS_Transport_UDPv4_get_priority_range \
  NDDS_Transport_UDP_get_priority_range
 
#define NDDS_Transport_UDPv4_Address_print NDDS_Transport_UDP_Address_print
 
extern NDDS_Transport_DllExport RTIBool
NDDS_Transport_UDPv4_WAN_Address_to_string(
        const NDDS_Transport_Address_t *me,
        char *buffer,
        size_t buffer_size_in);
 
extern NDDS_Transport_DllExport void NDDS_Transport_UDPv4_WAN_Address_print(
        const NDDS_Transport_Address_t *me,
        const char *desc,
        RTI_INT32 indent);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#include "transport/transport_udpv4_impl.h"
 
#endif /* transport_udpv4_h */