netio_udp.h

/*
 * FILE: netio_udp.h - UDP API
 *
 * Copyright 2008-2014 Real-Time Innovations, Inc.
 *
 * 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.
 *
 * Modification History
 * --------------------
 * 13mar2013,eh  Fix MICRO-352 (max message/send/receive sizes)
 * 25apr2012,tk  Written
 *
 */
/*ci
 * \file
 * \defgroup NETIO_UDPInterfaceClass UDP Interface
 * \ingroup NETIOModule
 * \brief NETIO UDP Interface
 *
 * \details
 *
 * The UDP interface is implemented as a NETIO interface and NETIO interface
 * factory.
 */
/*ci \addtogroup NETIO_UDPInterfaceClass
 * @{
 */
#ifndef netio_udp_h
#define netio_udp_h

#ifndef osapi_config_h
#include "osapi/osapi_config.h"
#endif
#ifndef osapi_thread_h
#include "osapi/osapi_thread.h"
#endif
#ifndef rt_rt_h
#include "rt/rt_rt.h"
#endif
#ifndef reda_string_h
#include "reda/reda_string.h"
#endif
#ifndef reda_sequence_h
#include "reda/reda_sequence.h"
#endif
#ifndef netio_dll_h
#include "netio/netio_dll.h"
#endif
#ifndef netio_config_h
#include "netio/netio_config.h"
#endif
#ifndef netio_address_h
#include "netio/netio_address.h"
#endif
#ifndef netio_route_h
#include "netio/netio_route.h"
#endif

#ifdef __cplusplus
extern "C"
{
#endif

/*ci
 * \brief Available UDP properties per interface
 */
struct UDP_InterfaceProperty
{
    /*ci
     * \brief Inherited properties
     */
    struct NETIO_InterfaceProperty _parent;
};

/*ci
 * \brief Costant to initialize UDP_InterfaceProperty
 */
#define UDP_InterfaceProperty_INITIALIZER \
{\
    NETIO_InterfaceProperty_INITIALIZER\
}

#ifndef RTI_CERT
struct UDP_NatEntry
{
    struct NETIO_Address local_address;
    struct NETIO_Address public_address;
};

#define UDP_NatEntry_INITIALIZER \
{\
    NETIO_Address_INITIALIZER,\
    NETIO_Address_INITIALIZER,\
}

REDA_DEFINE_SEQUENCE(UDP_NatEntrySeq,struct UDP_NatEntry)

#define UDP_NatEntrySeq_INITIALIZER \
                        REDA_DEFINE_SEQUENCE_INITIALIZER(struct UDP_NatEntry)

#endif /* !RTI_CERT */

/*ci
 * \def UDP_INTERFACE_MAX_IFNAME
 * \brief Maximum length of a UDP network interface
 */
#define UDP_INTERFACE_MAX_IFNAME 64

/*ci
 * \def UDP_INTERFACE_INTERFACE_UP_FLAG
 * \brief Generic flag to indicate if a network stack is up
 */
#define UDP_INTERFACE_INTERFACE_UP_FLAG        0x1

/*ci
 * \def UDP_INTERFACE_INTERFACE_MULTICAST_FLAG
 * \brief Generic flag to indicate if a network stack supports multicast
 */
#define UDP_INTERFACE_INTERFACE_MULTICAST_FLAG 0x2

/*ci
 * \brief Generic structure to describe a network interface
 */
struct UDP_InterfaceTableEntry
{
    /*ci
     * \brief Flags to indicate if the interface is up etc.
     */
    RTI_UINT32 flags;

    /*ci
     * \brief The address of interface as configured by the OS
     */
    RTI_UINT32 address;

    /*ci
     * \brief The netmask of interface as configured by the OS
     */
    RTI_UINT32 netmask;

    /*ci
     * \brief The name of interface as configured by the OS
     */
    char ifname[UDP_INTERFACE_MAX_IFNAME];
};

/*ci
 * \def UDP_InterfaceTableEntry_INITIALIZER
 * \brief Constant to initialize \ref UDP_InterfaceTableEntry
 */
#define UDP_InterfaceTableEntry_INITIALIZER \
{\
    0,\
    0,\
    0,\
    {0}\
}

REDA_DEFINE_SEQUENCE(UDP_InterfaceTableEntrySeq,struct UDP_InterfaceTableEntry)

#define UDP_InterfaceTableEntrySeq_INITIALIZER \
               REDA_DEFINE_SEQUENCE_INITIALIZER(struct UDP_InterfaceTableEntry)

/*ci
 * \brief Add an entry to the list of available interfaces
 *
 * \details
 *
 * \param[in] seq     The sequence to add the entry too
 * \param[in] address The interface address
 * \param[in] netmask The interface netmask
 * \param[in] ifname  The interface nmae
 * \param[in] flags   The interface state and features
 *
 * \return RTI_TRUE on success, RTI_FALSE on failure
 */
MUST_CHECK_RETURN NETIODllExport RTI_BOOL
UDP_InterfaceTable_add_entry(struct UDP_InterfaceTableEntrySeq *seq,
                             RTI_UINT32 address,
                             RTI_UINT32 netmask,
                             const char *ifname,
                             RTI_UINT32 flags);

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

#ifdef __cplusplus
extern "C" 
{
#endif

struct UDP_InterfaceFactoryProperty;
NETIODllExport RTI_BOOL
UDP_InterfaceFactoryProperty_initialize(
            struct UDP_InterfaceFactoryProperty* self);

NETIODllExport RTI_BOOL
UDP_InterfaceFactoryProperty_finalize(
        struct UDP_InterfaceFactoryProperty *p);

#ifdef __cplusplus
}
#endif

/*ci
 * \brief Properties the UDP interface can be registered with
 */
struct UDP_InterfaceFactoryProperty
{
    /*ci
     * \brief Inherited property struct
     */
    struct NETIO_InterfaceFactoryProperty _parent;

    /*ci
     * \brief Sequence of allowed interface names
     */
    struct REDA_StringSeq allow_interface;

    /*ci
     * \brief Sequence of denied interface names
     */
    struct REDA_StringSeq deny_interface;

    /*ci
     * \brief The size of the send socket buffer
     */
    RTI_INT32 max_send_buffer_size;

    /*ci
     * \brief The size of the receive socket buffer
     */
    RTI_INT32 max_receive_buffer_size;
    
    /*ci
     * \brief The maximum size of the message which can be received
     */
    RTI_INT32 max_message_size;

    /*ci
     * \brief The maximum TTL
     */
    RTI_INT32 multicast_ttl;

#ifndef RTI_CERT
    struct UDP_NatEntrySeq nat;
#endif /* !RTI_CERT */

    /*ci
     * \brief The interface table if interfaces are added manually
     */
    struct UDP_InterfaceTableEntrySeq if_table;

    /*ci
     * \brief The network interface to use to send to multicast
     */
    REDA_String_T multicast_interface;

    /*ci
     * \brief If this should be considered the default UDP interfaces if
     *        no other UDP interface is found to handle a route
     */
    RTI_BOOL is_default_interface;

    /*ci
     * \brief Disable reading of available network interfaces using system
     *        information and instead rely on the manually configured
     *        interface table
     */
    RTI_BOOL disable_auto_interface_config;

    /*ci
     * \brief Thread properties for each receive thread created by this
     *        NETIO interface.
     */
    struct OSAPI_ThreadProperty recv_thread;

#ifdef RTI_CPP
     public:
        UDP_InterfaceFactoryProperty()
        {
            UDP_InterfaceFactoryProperty_initialize(this);
        }
        ~UDP_InterfaceFactoryProperty() { }
    private:\
        UDP_InterfaceFactoryProperty(
                const struct UDP_InterfaceFactoryProperty& from )
        {
            UNUSED_ARG(from);
        }
        struct UDP_InterfaceFactoryProperty& operator=(
                const struct UDP_InterfaceFactoryProperty& from )
        {
            UNUSED_ARG(from);
            return *this;
        }
        bool operator==(
                const struct UDP_InterfaceFactoryProperty& other)
        {
            UNUSED_ARG(other);
            return false;
        }
        bool operator!=(
                const struct UDP_InterfaceFactoryProperty& other)
        {
            UNUSED_ARG(other);
            return false;
        }
#endif
};

#ifdef __cplusplus
extern "C"
{
#endif

/*ci
 * \def UDP_InterfaceFactoryProperty_INITIALIZER
 * \brief Constant to initialize UDP_InterfaceFactoryProperty
 */
#if (OSAPI_PLATFORM == OSAPI_PLATFORM_VXWORKS) && \
    (!VXWORKS_VERSION_6_3_OR_BETTER)  

#define UDP_InterfaceFactoryProperty_INITIALIZER \
{\
    NETIO_InterfaceFactoryProperty_INITIALIZER,\
    REDA_StringSeq_INITIALIZER,\
    REDA_StringSeq_INITIALIZER,\
    (8*1024),\
    (8*1024),\
    (8*1024),\
    1,\
    UDP_NatEntrySeq_INITIALIZER,\
    UDP_InterfaceTableEntrySeq_INITIALIZER,\
    NULL,\
    RTI_TRUE,\
    RTI_FALSE, \
    OSAPI_THREAD_PROPERTY_DEFAULT \
}
#else /* !VxWorks <6.3 */

#ifndef RTI_CERT
#define UDP_InterfaceFactoryProperty_INITIALIZER \
{\
    NETIO_InterfaceFactoryProperty_INITIALIZER,\
    REDA_StringSeq_INITIALIZER,\
    REDA_StringSeq_INITIALIZER,\
    (256*1024),\
    (256*1024),\
    (8*1024),\
    1,\
    UDP_NatEntrySeq_INITIALIZER,\
    UDP_InterfaceTableEntrySeq_INITIALIZER,\
    NULL,\
    RTI_TRUE,\
    RTI_FALSE, \
    OSAPI_THREAD_PROPERTY_DEFAULT \
}
#else 
#define UDP_InterfaceFactoryProperty_INITIALIZER \
{\
    NETIO_InterfaceFactoryProperty_INITIALIZER,\
    REDA_StringSeq_INITIALIZER,\
    REDA_StringSeq_INITIALIZER,\
    (8*1024),\
    (8*1024),\
    (8*1024),\
    1,\
    UDP_InterfaceTableEntrySeq_INITIALIZER,\
    NULL,\
    RTI_TRUE,\
    RTI_FALSE, \
    OSAPI_THREAD_PROPERTY_DEFAULT \
}
#endif /* !RTI_CERT */
#endif

#define UDP_INTERFACE_INTERFACE_ID RT_MKINTERFACEID(\
            RT_COMPONENT_CLASS_NETIO,RT_COMPONENT_INSTANCE_UDP)

extern NETIODllVariable struct UDP_InterfaceFactoryProperty UDP_INTERFACE_FACTORY_PROPERTY_DEFAULT;

/*ci
 * \brief Function to retrieve the concrete implementation of the
 *        NETIO UDP interface.
 *
 * \return Pointer to UDP interface implementation
 */

MUST_CHECK_RETURN NETIODllExport struct RT_ComponentFactoryI*
UDP_InterfaceFactory_get_interface(void);

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

#endif /* netio_udp_h */

/*ci @} */