This is documentation for an old version.
logo

Getting started

  • 1. Introduction
  • 2. Installing eCAL
  • 3. eCAL Samples
  • 4. Network configuration
  • 5. eCAL Services
  • 6. Applications
    • 6.1. Monitor
    • 6.2. Recorder
    • 6.3. Player
    • 6.4. Sys
  • 7. Development (C++)
    • 7.1. Hello World
    • 7.2. Hello World with protobuf
  • 8. Development (Python)
    • 8.1. Hello World (Python)
    • 8.2. Hello World with protobuf (Python)

Development

  • Building eCAL
    • Building eCAL from source
    • CMake options
  • eCAL API
    • C++
      • Namespace eCAL
      • Namespace eCAL::Config
      • Namespace eCAL::Config::Experimental
      • Namespace eCAL::eh5
      • Namespace eCAL::Init
      • Namespace eCAL::Logging
      • Namespace eCAL::Monitoring
      • Namespace eCAL::pb
      • Namespace eCAL::Process
      • Namespace eCAL::QOS
      • Namespace eCAL::Time
      • Namespace eCAL::TLayer
      • Namespace eCAL::Util
      • Struct SReaderQOS
      • Struct SWriterQOS
      • Struct SClientAttr
      • Struct SClientEventCallbackData
      • Struct SDataTypeInformation
      • Struct SEventHandle
      • Struct SPubEventCallbackData
      • Struct SReceiveCallbackData
      • Struct SServerEventCallbackData
      • Struct SServiceAttr
      • Struct SServiceMethodInformation
      • Struct SServiceResponse
      • Struct SSubEventCallbackData
      • Struct STopicInformation
      • Struct STLayer
      • Class CDynamicSleeper
      • Template Class CMsgPublisher
      • Template Class CMsgSubscriber
      • Class CPayloadWriter
      • Class CPublisher
      • Class CServiceClient
      • Class CServiceServer
      • Class CSubscriber
      • Class CTimedCB
      • Class CTimer
      • Class HDF5Meas
      • Enum UdpConfigVersion
      • Enum eAccessType
      • Enum eQOSPolicy_HistoryKind
      • Enum eQOSPolicy_Reliability
      • Enum eSendMode
      • Enum eTransportLayer
      • Enum eCAL_Logging_eLogLevel
      • Enum eCAL_Process_eSeverity
      • Enum eCAL_Process_eSeverity_Level
      • Enum eCAL_Process_eStartMode
      • Function client_call_method
      • Function client_call_method_async
      • Function client_create
      • Function client_destroy
      • Function client_set_hostname
      • Function dyn_json_sub_add_receive_callback
      • Function dyn_json_sub_create
      • Function dyn_json_sub_destroy
      • Function dyn_json_sub_rem_receive_callback
      • Function eCAL::Config::Experimental::GetDropOutOfOrderMessages
      • Function eCAL::Config::Experimental::GetShmMonitoringDomain
      • Function eCAL::Config::Experimental::GetShmMonitoringQueueSize
      • Function eCAL::Config::Experimental::IsNetworkMonitoringDisabled
      • Function eCAL::Config::Experimental::IsShmMonitoringEnabled
      • Function eCAL::Config::GetConsoleLogFilter
      • Function eCAL::Config::GetEcalSysFilterExcludeList
      • Function eCAL::Config::GetFileLogFilter
      • Function eCAL::Config::GetHostGroupName
      • Function eCAL::Config::GetLoadedEcalIniPath
      • Function eCAL::Config::GetMaxUdpBandwidthBytesPerSecond
      • Function eCAL::Config::GetMemfileAckTimeoutMs
      • Function eCAL::Config::GetMemfileBufferCount
      • Function eCAL::Config::GetMemfileMinsizeBytes
      • Function eCAL::Config::GetMemfileOverprovisioningPercentage
      • Function eCAL::Config::GetMonitoringFilterExcludeList
      • Function eCAL::Config::GetMonitoringFilterIncludeList
      • Function eCAL::Config::GetMonitoringTimeoutMs
      • Function eCAL::Config::GetPublisherInprocMode
      • Function eCAL::Config::GetPublisherShmMode
      • Function eCAL::Config::GetPublisherTcpMode
      • Function eCAL::Config::GetPublisherUdpMulticastMode
      • Function eCAL::Config::GetRegistrationRefreshMs
      • Function eCAL::Config::GetRegistrationTimeoutMs
      • Function eCAL::Config::GetTcpPubsubMaxReconnectionAttemps
      • Function eCAL::Config::GetTcpPubsubReaderThreadpoolSize
      • Function eCAL::Config::GetTcpPubsubWriterThreadpoolSize
      • Function eCAL::Config::GetTerminalEmulatorCommand
      • Function eCAL::Config::GetTimesyncModuleName
      • Function eCAL::Config::GetUdpLogFilter
      • Function eCAL::Config::GetUdpMulticastConfigVersion
      • Function eCAL::Config::GetUdpMulticastGroup
      • Function eCAL::Config::GetUdpMulticastMask
      • Function eCAL::Config::GetUdpMulticastPort
      • Function eCAL::Config::GetUdpMulticastRcvBufSizeBytes
      • Function eCAL::Config::GetUdpMulticastSndBufSizeBytes
      • Function eCAL::Config::GetUdpMulticastTtl
      • Function eCAL::Config::IsInprocRecEnabled
      • Function eCAL::Config::IsMemfileZerocopyEnabled
      • Function eCAL::Config::IsNetworkEnabled
      • Function eCAL::Config::IsNpcapEnabled
      • Function eCAL::Config::IsShmRecEnabled
      • Function eCAL::Config::IsTcpRecEnabled
      • Function eCAL::Config::IsTopicDescriptionSharingEnabled
      • Function eCAL::Config::IsTopicTypeSharingEnabled
      • Function eCAL::Config::IsUdpMulticastJoinAllIfEnabled
      • Function eCAL::Config::IsUdpMulticastRecEnabled
      • Function eCAL::Finalize
      • Function eCAL::gCloseEvent
      • Function eCAL::GetVersion
      • Function eCAL::GetVersionDateString
      • Function eCAL::GetVersionString
      • Function eCAL::gEventIsValid
      • Function eCAL::gInvalidateEvent
      • Function eCAL::gOpenEvent
      • Function eCAL::gSetEvent
      • Function eCAL::gWaitForEvent
      • Function eCAL::Initialize(int, char **, const char *, unsigned int)
      • Function eCAL::Initialize(std::vector<std::string>, const char *, unsigned int)
      • Function eCAL::IsInitialized
      • Function eCAL::Logging::GetCoreTime
      • Function eCAL::Logging::GetLogLevel
      • Function eCAL::Logging::Log(const std::string&)
      • Function eCAL::Logging::Log(eCAL_Logging_eLogLevel, const std::string&)
      • Function eCAL::Logging::SetCoreTime
      • Function eCAL::Logging::SetLogLevel
      • Function eCAL::Logging::StartCoreTimer
      • Function eCAL::Logging::StopCoreTimer
      • Function eCAL::Monitoring::GetLogging
      • Function eCAL::Monitoring::GetMonitoring(std::string&)
      • Function eCAL::Monitoring::GetMonitoring(std::string&, unsigned int)
      • Function eCAL::Monitoring::GetMonitoring(eCAL::Monitoring::SMonitoring&, unsigned int)
      • Function eCAL::Monitoring::PubLogging
      • Function eCAL::Monitoring::PubMonitoring
      • Function eCAL::Monitoring::SetExclFilter
      • Function eCAL::Monitoring::SetFilterState
      • Function eCAL::Monitoring::SetInclFilter
      • Function eCAL::Ok
      • Function eCAL::Process::AddRegistrationCallback
      • Function eCAL::Process::DumpConfig()
      • Function eCAL::Process::DumpConfig(std::string&)
      • Function eCAL::Process::GetHostGroupName
      • Function eCAL::Process::GetHostID
      • Function eCAL::Process::GetHostName
      • Function eCAL::Process::GetProcessCpuUsage
      • Function eCAL::Process::GetProcessID
      • Function eCAL::Process::GetProcessIDAsString
      • Function eCAL::Process::GetProcessMemory
      • Function eCAL::Process::GetProcessName
      • Function eCAL::Process::GetProcessParameter
      • Function eCAL::Process::GetRBytes
      • Function eCAL::Process::GetRClock
      • Function eCAL::Process::GetSBytes
      • Function eCAL::Process::GetSClock
      • Function eCAL::Process::GetTaskParameter
      • Function eCAL::Process::GetUnitName
      • Function eCAL::Process::GetWBytes
      • Function eCAL::Process::GetWClock
      • Function eCAL::Process::RemRegistrationCallback
      • Function eCAL::Process::SetState
      • Template Function eCAL::Process::SleepFor
      • Function eCAL::Process::SleepMS
      • Function eCAL::Process::SleepNS
      • Function eCAL::Process::StartProcess
      • Function eCAL::Process::StopProcess(const char *)
      • Function eCAL::Process::StopProcess(int)
      • Function eCAL::SetUnitName
      • Function eCAL::Time::GetMicroSeconds
      • Function eCAL::Time::GetName
      • Function eCAL::Time::GetNanoSeconds
      • Function eCAL::Time::GetStatus
      • Function eCAL::Time::IsMaster
      • Function eCAL::Time::IsSynchronized
      • Function eCAL::Time::SetNanoSeconds
      • Template Function eCAL::Time::sleep_for
      • Function eCAL::Time::SleepForNanoseconds
      • Function eCAL::Util::CombinedTopicEncodingAndType
      • Function eCAL::Util::EnableLoopback
      • Function eCAL::Util::GetDescription(const std::string&, std::string&)
      • Function eCAL::Util::GetDescription(const std::string&)
      • Function eCAL::Util::GeteCALActiveIniFile
      • Function eCAL::Util::GeteCALConfigPath
      • Function eCAL::Util::GeteCALDefaultIniFile
      • Function eCAL::Util::GeteCALHomePath
      • Function eCAL::Util::GeteCALLogPath
      • Function eCAL::Util::GeteCALUserSettingsPath
      • Function eCAL::Util::GetServiceDescription
      • Function eCAL::Util::GetServiceNames
      • Function eCAL::Util::GetServices
      • Function eCAL::Util::GetServiceTypeNames
      • Function eCAL::Util::GetTopicDataTypeInformation
      • Function eCAL::Util::GetTopicDescription(const std::string&, std::string&)
      • Function eCAL::Util::GetTopicDescription(const std::string&)
      • Function eCAL::Util::GetTopicNames
      • Function eCAL::Util::GetTopics
      • Function eCAL::Util::GetTopicTypeName(const std::string&, std::string&)
      • Function eCAL::Util::GetTopicTypeName(const std::string&)
      • Function eCAL::Util::GetTypeName(const std::string&, std::string&)
      • Function eCAL::Util::GetTypeName(const std::string&)
      • Function eCAL::Util::PubShareDescription
      • Function eCAL::Util::PubShareType
      • Function eCAL::Util::ShutdownCore
      • Function eCAL::Util::ShutdownProcess(const std::string&)
      • Function eCAL::Util::ShutdownProcess(int)
      • Function eCAL::Util::ShutdownProcesses
      • Function eCAL::Util::SplitCombinedTopicType
      • Function ecal_enable_loopback
      • Function ecal_finalize
      • Function ecal_free_mem
      • Function ecal_get_description
      • Function ecal_get_type_name
      • Function ecal_getdate
      • Function ecal_getversion
      • Function ecal_initialize
      • Function ecal_ok
      • Function ecal_set_process_state
      • Function ecal_shutdown_core
      • Function ecal_shutdown_process_id
      • Function ecal_shutdown_process_uname
      • Function ecal_shutdown_processes
      • Function ecal_sleep_ms
      • Function etime_finalize
      • Function etime_get_nanoseconds
      • Function etime_get_status
      • Function etime_initialize
      • Function etime_is_master
      • Function etime_is_synchronized
      • Function etime_set_nanoseconds
      • Function etime_sleep_for_nanoseconds
      • Function log_message
      • Function log_setcoretime
      • Function log_setlevel
      • Function mon_finalize
      • Function mon_get_logging
      • Function mon_get_monitoring
      • Function mon_initialize
      • Function mon_set_excl_filter
      • Function mon_set_filter_state
      • Function mon_set_incl_filter
      • Function pub_add_event_callback
      • Function pub_create
      • Function pub_destroy
      • Function pub_get_qos
      • Function pub_rem_event_callback
      • Function pub_send
      • Function pub_send_sync
      • Function pub_set_description
      • Function pub_set_layer_mode
      • Function pub_set_max_bandwidth_udp
      • Function pub_set_qos
      • Function pub_set_type_name
      • Function server_add_method_callback
      • Function server_create
      • Function server_destroy
      • Function server_rem_method_callback
      • Function sub_add_event_callback
      • Function sub_add_receive_callback
      • Function sub_create
      • Function sub_destroy
      • Function sub_get_qos
      • Function sub_receive
      • Function sub_receive_buffer
      • Function sub_rem_event_callback
      • Function sub_rem_receive_callback
      • Function sub_set_qos
      • Function sub_set_timeout
      • Variable eCAL::Init::All
      • Variable eCAL::Init::Default
      • Variable eCAL::Init::Logging
      • Variable eCAL::Init::Monitoring
      • Variable eCAL::Init::None
      • Variable eCAL::Init::ProcessReg
      • Variable eCAL::Init::Publisher
      • Variable eCAL::Init::Service
      • Variable eCAL::Init::Subscriber
      • Variable eCAL::Init::TimeSync
      • Define ECAL_ALLOCATE_4ME
      • Define ECAL_API
      • Define ECAL_DEPRECATE_SINCE_5_10
      • Define ECAL_DEPRECATE_SINCE_5_11
      • Define ECAL_DEPRECATE_SINCE_5_12
      • Define ECAL_DEPRECATE_SINCE_5_13
      • Define ECAL_DEPRECATE_SINCE_5_4
      • Define ECAL_HDF5_DATE
      • Define ECAL_HDF5_NAME
      • Define ECAL_HDF5_VERSION
      • Define ECAL_HDF5_VERSION_MAJOR
      • Define ECAL_HDF5_VERSION_MINOR
      • Define ECAL_HDF5_VERSION_PATCH
      • Define ECALC_API
      • Define ECALC_API_DEPRECATED
      • Define ECALTIME_API
      • Typedef eCAL::ClientEventCallbackT
      • Typedef eCAL::EntryInfoSet
      • Typedef eCAL::EntryInfoVect
      • Typedef eCAL::MethodCallbackT
      • Typedef eCAL::PubEventCallbackT
      • Typedef eCAL::ReceiveCallbackT
      • Typedef eCAL::RegistrationCallbackT
      • Typedef eCAL::ResponseCallbackT
      • Typedef eCAL::ServerEventCallbackT
      • Typedef eCAL::ServiceResponseVecT
      • Typedef eCAL::SubEventCallbackT
      • Typedef eCAL::TimerCallbackT
      • Typedef ECAL_HANDLE
      • Typedef eCAL_Logging_Filter
    • python
      • ecal package
        • ecal.core package
        • ecal.measurement package
        • ecal.proto package
      • setup module

Using eCAL

  • Configuration
    • Cloud Configuration
    • Local configuration
    • Npcap
    • Player - Max open files
    • ecal.ini
  • Applications
    • eCAL Rec
      • eCAL Rec Architecture
      • eCAL Rec GUI
      • eCAL Rec CLI
      • eCAL Rec Client
    • eCAL Sys
      • eCAL Sys Architecture
      • eCAL Sys GUI
      • eCAL Sys CLI
      • eCAL Sys Client
    • eCAL Measurement Cutter
  • FAQ

Advanced

  • eCAL Versions
    • eCAL Compatibility
    • eCAL 5.12
    • eCAL 5.11
    • eCAL 5.10
    • eCAL 5.9
    • eCAL 5.8
  • Downloads
  • Tutorials
    • Edit the documentation
    • eCAL in Docker
    • Building eCAL with Conan dependencies
    • Distributed Recordings with eCAL Rec
  • eCAL internals
    • Performance measurements
    • Transport Layers
      • eCAL SHM Layer
        • eCAL Zero Copy
      • eCAL UDP Layer
      • eCAL TCP Layer
      • eCAL Inner-Process Layer
    • Message Drops
    • Threading model
    • eCAL Measurement Format
  • How eCAL relates to ROS
  • License
    • eCAL License
    • External components
      • Apache 2.0
      • Boost Software License 1.0
      • BSD 3
      • Convert UTF License
      • Creative Commons 3.0
      • Findqwt-style BSD2
      • Fontawesome Free License
      • GPL 2.0
      • GPL 3.0
      • HDF5 BSD-3
      • LGPL 2.1
      • LGPL 3.0
      • MIT
      • Npcap license
      • qwt
      • Unlicense
      • zlib
    • Icon License
  • repository
  • open issue
  • suggest edit
  • .rst
Contents
  • Definition ( ecal/core/include/ecal/ecal_deprecate.h )
  • Includes
  • Included By
  • Defines

File ecal_deprecate.h

Contents

  • Definition ( ecal/core/include/ecal/ecal_deprecate.h )
  • Includes
  • Included By
  • Defines

File ecal_deprecate.h#

eCAL function / variable deprecation macros

Contents

  • Definition (ecal/core/include/ecal/ecal_deprecate.h)

  • Includes

  • Included By

  • Defines

Definition (ecal/core/include/ecal/ecal_deprecate.h)#

  • Program Listing for File ecal_deprecate.h

Includes#

  • ecal/ecal_defs.h

Included By#

  • File ecal_callback.h

  • File ecal_client.h

  • File ecal_monitoring.h

  • File ecal_process.h

  • File ecal_publisher.h

  • File ecal_server.h

  • File ecal_subscriber.h

  • File ecal_util.h

  • File publisher.h

  • File subscriber.h

Defines#

  • Define ECAL_DEPRECATE_SINCE_5_10

  • Define ECAL_DEPRECATE_SINCE_5_11

  • Define ECAL_DEPRECATE_SINCE_5_12

  • Define ECAL_DEPRECATE_SINCE_5_13

  • Define ECAL_DEPRECATE_SINCE_5_4

© Copyright 2023, Continental.

Eclipse Foundation

  • Website

  • Privacy policy

  • Terms of Use

  • Copyright agent

  • Legal