torsten
77c67c12ca
Entire-Metadata: .entire/metadata/fb87247f-2a75-407e-b336-cbc8c20ba5a6 Entire-Session: fb87247f-2a75-407e-b336-cbc8c20ba5a6 Entire-Strategy: manual-commit
262 lines
8.0 KiB
C
262 lines
8.0 KiB
C
/*
|
|
* Copyright (c) 2009-2024 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 rtitls_connection_h
|
|
#define rtitls_connection_h
|
|
|
|
#ifndef rtitls_openssl_h
|
|
#include "rtitls/rtitls_openssl.h"
|
|
#endif
|
|
/* #ifndef transport_endpoint_h
|
|
#include "transport/transport_endpoint.h"
|
|
#endif*/
|
|
#ifndef rtitls_endpoint_h
|
|
#include "rtitls/rtitls_endpoint.h"
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* {{{ Connection Endpoint Factory Property for TLSv4
|
|
* ================================================================= */
|
|
|
|
/*i \ingroup RTITLSConnectionComponent
|
|
* \brief The connection endpoint factory property for TLSv4
|
|
*/
|
|
struct RTITLS_ConnectionEndpointFactoryPropertyTLSv4 {
|
|
struct NDDS_Transport_ConnectionEndpointFactoryProperty parent;
|
|
|
|
|
|
/* TODO: most of these should be moved to an OSAPI or Transport socket
|
|
factory component; osapi/socket or transport/socketutil */
|
|
|
|
/*e The size of the send buffers for the TCP sockets that are
|
|
* used for control AND data communication.
|
|
*
|
|
* \default NDDS_Transport_TCPv4_Plugin#NDDS_TRANSPORT_TCPV4_SOCKET_BUFFER_SIZE_OS_DEFAULT
|
|
*/
|
|
RTI_INT32 send_socket_buffer_size;
|
|
|
|
|
|
/*e The size of the receive buffers for the TCP sockets used for control
|
|
* AND data communication.
|
|
*
|
|
* \default NDDS_Transport_TCPv4_Plugin#NDDS_TRANSPORT_TCPV4_SOCKET_BUFFER_SIZE_OS_DEFAULT
|
|
*/
|
|
RTI_INT32 recv_socket_buffer_size;
|
|
|
|
|
|
/*e
|
|
* If different than -1, assigns it to the socket option TCP_MAXSEG.
|
|
*
|
|
* \default -1 (use system's socket default)
|
|
*/
|
|
RTI_INT32 max_packet_size;
|
|
|
|
/*e
|
|
* Enable keep alive. If this is set to a value different than 0, the parameters
|
|
* \ref keep_alive_time, \ref keep_alive_interval, \ref keep_alive_retry_count
|
|
* will be used to configure the keep alive feature of the created socket.
|
|
*
|
|
* NOTE: This parameter is not supported on all the architectures. You will
|
|
* see a warning message if keep alive is enabled on a non-supported
|
|
* architecture.
|
|
*
|
|
* Currently this feature is supported only on Linux.
|
|
*
|
|
* On Windows, you can modify those settings (at system's level) through
|
|
* the system's registry at:
|
|
* \code
|
|
* \HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Tcpip\Parameters.
|
|
* \endcode
|
|
* See MSDN or Windows documentation for more information.
|
|
*
|
|
* \default 0 (disabled)
|
|
*/
|
|
RTI_INT32 enable_keep_alive;
|
|
|
|
/*e
|
|
* Keep alive time in seconds of inactivity.
|
|
*
|
|
* Valid only if \ref enable_keep_alive is set to 1.
|
|
*
|
|
* \default -1 (use system's default).
|
|
*/
|
|
RTI_INT32 keep_alive_time;
|
|
|
|
/*e
|
|
* Keep alive interval in seconds.
|
|
*
|
|
* Valid only if \ref enable_keep_alive is set to 1.
|
|
*
|
|
* \default -1 (use system's default).
|
|
*/
|
|
RTI_INT32 keep_alive_interval;
|
|
|
|
|
|
/*e
|
|
* Keep alive retry count.
|
|
*
|
|
* Valid only if \ref enable_keep_alive is set to 1.
|
|
*
|
|
* \default -1 (use system's default).
|
|
*/
|
|
RTI_INT32 keep_alive_retry_count;
|
|
|
|
/*e
|
|
* Changes the default OS TCP User Timeout configuration. If set to a value
|
|
* greater than 0, it represents the TCP User Timeout in seconds.
|
|
*
|
|
* Currently this feature is supported only on Linux 2.6.37 and above.
|
|
*
|
|
* \default 0 (use system's default).
|
|
*/
|
|
RTI_INT32 user_timeout;
|
|
|
|
/*e
|
|
* Disable Nagle algorithm for TCP communication.
|
|
*
|
|
* \default 0 (disabled)
|
|
*/
|
|
RTI_INT32 disable_nagle;
|
|
|
|
|
|
/*e
|
|
This is used in conjunction with
|
|
\ref transport_priority_mapping_low and \ref transport_priority_mapping_high
|
|
to define the mapping from DDS transport priority (see
|
|
\ref DDSTransportPriorityQosModule) to the
|
|
IPv4 TOS field. Defines a contiguous region of bits in the
|
|
32-bit transport priority value that is used
|
|
to generate values for the IPv4 TOS field on an outgoing
|
|
socket.
|
|
|
|
For example, the value 0x0000ff00 causes bits 9-16
|
|
(8 bits) to be used in the mapping. The value will be
|
|
scaled from the mask range (0x0000 - 0xff00 in this case) to
|
|
the range specified by low and high.
|
|
|
|
If the mask is set to zero, then the transport will not
|
|
set IPv4 TOS for send sockets.
|
|
*/
|
|
RTI_INT32 transport_priority_mask;
|
|
|
|
/*e
|
|
This is used in conjunction with
|
|
\ref transport_priority_mask and \ref transport_priority_mapping_high
|
|
to define the mapping from DDS transport priority to the
|
|
IPv4 TOS field. Defines the low value of the
|
|
output range for scaling.
|
|
|
|
Note that IPv4 TOS is generally an 8-bit value.
|
|
|
|
\see transport_priority_mask
|
|
|
|
\default 0.
|
|
*/
|
|
RTI_INT32 transport_priority_mapping_low;
|
|
|
|
/*e
|
|
This is used in conjunction with
|
|
\ref transport_priority_mask and \ref transport_priority_mapping_high
|
|
to define the mapping from DDS transport priority to the
|
|
IPv4 TOS field. Defines the high value of the
|
|
output range for scaling.
|
|
|
|
Note that IPv4 TOS is generally an 8-bit value.
|
|
|
|
\see transport_priority_mask
|
|
|
|
\default 0.
|
|
*/
|
|
RTI_INT32 transport_priority_mapping_high;
|
|
|
|
/*e
|
|
* This is used to select between synchronous or asynchronous accept.
|
|
* Currently this is set to one only when using Windows IOCP.
|
|
*
|
|
* \default 0
|
|
*/
|
|
RTIBool use_asynchronous_accept;
|
|
|
|
/*e \brief OpenSSL TLS parameters
|
|
*
|
|
* \default RTITLS_OpenSSL#RTITLS_OPENSSL_CONFIGURATION_DEFAULT
|
|
*/
|
|
struct RTITLS_OpenSSL_Configuration tls;
|
|
|
|
/*e \brief Bitmap that specifies the verbosity of log messages generated
|
|
by OpenSSL
|
|
|
|
Logging values:
|
|
<ul>
|
|
<li>0x00: silence
|
|
<li>0x01: fatal error
|
|
<li>0x02: errors
|
|
<li>0x04: warnings
|
|
<li>0x08: local
|
|
<li>0x10: remote
|
|
<li>0x20: period
|
|
</ul>
|
|
|
|
You can combine these values by logically ORing them together.
|
|
|
|
\default 0x07 fatal errors & errors & warnings
|
|
*/
|
|
RTI_INT32 logging_verbosity_bitmap;
|
|
};
|
|
|
|
/*i \ingroup RTITLSConnectionComponent
|
|
* \brief Default connection endpoint factory property for TLSv4
|
|
*/
|
|
#define RTITLS_CONNECTION_ENDPOINT_FACTORY_PROPERTY_TLSV4_DEFAULT { \
|
|
{ NDDS_TRANSPORT_CONNECTION_ENDPOINT_KIND_TLSv4 }, /* parent.kind */ \
|
|
-1, /* send_socket_buffer_size */ \
|
|
-1, /* recv_socket_buffer_size */ \
|
|
-1, /* max_packet_size */ \
|
|
0, /* enable_keep_alive */ \
|
|
-1, /* keep_alive_time */ \
|
|
-1, /* keep_alive_interval */ \
|
|
-1, /* keep_alive_retry_count */ \
|
|
0, /* user_timeout */ \
|
|
0, /* disable_nagle */ \
|
|
0, /* transport_priority_mask */ \
|
|
0, /* transport_priority_mapping_low */ \
|
|
0, /* transport_priority_mapping_high */ \
|
|
0, /* use_asynchronous_accept */ \
|
|
RTITLS_OPENSSL_CONFIGURATION_DEFAULT, /* tls */ \
|
|
RTI_LOG_BIT_FATAL_ERROR | RTI_LOG_BIT_EXCEPTION | RTI_LOG_BIT_WARN \
|
|
}
|
|
|
|
/* }}} */
|
|
|
|
extern RTITLSDllExport
|
|
struct NDDS_Transport_ConnectionEndpointFactory *
|
|
RTITLS_ConnectionEndpointFactoryTLSv4_create(
|
|
struct RTITLS_ConnectionEndpointFactoryPropertyTLSv4 *factory_property);
|
|
|
|
extern RTITLSDllExport
|
|
void RTITLS_ConnectionEndpointFactoryTLSv4_delete(
|
|
struct NDDS_Transport_ConnectionEndpointFactory *factory);
|
|
|
|
/* ------------------------------------------------------------------------- */
|
|
/*e \ingroup RTITLSConnectionEndpointFactoryClass
|
|
\brief Used to specify that os default should be used for the
|
|
socket buffer size.
|
|
*/
|
|
#define RTITLS_SOCKET_BUFFER_SIZE_OS_DEFAULT (-1)
|
|
|
|
|
|
/* ================================================================= */
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|
|
|
|
#endif /* rtitls_connection_h */
|