Library API

Class Hierarchy

• Namespace netio3

  • Namespace netio3::utility

    • Template Class ConditionalLockGuard

    • Template Class ConditionalUniqueLock

  • Struct BufferMsg

  • Struct BufferStats

  • Struct NetioPublisherConfig

  • Struct NetioReceiverConfig

  • Struct NetioSenderConfig

  • Struct NetioSubscriberConfig

  • Struct PublisherStats

  • Struct SubscriptionAcknowledgement

  • Struct SubscriptionRequest

  • Class BufferFormatter

  • Template Class NetioPublisherTemplate

    • Struct NetioPublisherTemplate::ConnectionEndpointPair

  • Class NetioReceiver

  • Class NetioSender

    • Class NetioSender::Connection

  • Class NetioSubscriber

  • Class SubscriptionEndpointMap

    • Struct SubscriptionEndpointMap::Hash

  • Enum DecoderStatus

  • Enum FormatterStatus

  • Enum NetioPublisherStatus

  • Enum SendMethod

File Hierarchy

• Directory netio3

  • Directory SubscriptionEndpointContainer

    • File Definition.hpp

    • File SubscriptionEndpointMap.hpp

  • File BufferFormatter.hpp

  • File MonitoringStats.hpp

  • File NetioIssues.hpp

  • File NetioPublisher.hpp

  • File NetioReceiver.hpp

  • File NetioSender.hpp

  • File NetioSubscriber.hpp

  • File SubscriptionRequest.hpp

  • File Types.hpp

  • File Utility.hpp

• File BufferFormatter.cpp

• File NetioReceiver.cpp

• File NetioSender.cpp

• File NetioSubscriber.cpp

• File SubscriptionRequest.cpp

Full API

Namespaces

• Namespace netio3
  • Namespaces
  • Classes
  • Enums
  • Functions
  • Typedefs
  • Variables

• Namespace netio3::utility
  • Classes

• Namespace std::chrono_literals

Classes and Structs

• Struct BufferMsg
  • Struct Documentation
    • netio3::BufferMsg
      • status
      • tag
      • payload
      • decoder_status

• Struct BufferStats
  • Struct Documentation
    • netio3::BufferStats
      • ip
      • port
      • available_buffers

• Struct NetioPublisherConfig
  • Struct Documentation
    • netio3::NetioPublisherConfig
      • backend_type
      • backend_mode
      • buffersize
      • nbuffers
      • flush_interval
      • mr_start
      • method
      • thread_safety

• Struct NetioPublisherTemplate::ConnectionEndpointPair
  • Nested Relationships
  • Struct Documentation
    • netio3::NetioPublisherTemplate::ConnectionEndpointPair
      • con

• Struct NetioReceiverConfig
  • Struct Documentation
    • netio3::NetioReceiverConfig
      • backend_type
      • backend_mode
      • thread_safety

• Struct NetioSenderConfig
  • Struct Documentation
    • netio3::NetioSenderConfig
      • backend_type
      • backend_mode
      • buffersize
      • nbuffers
      • flush_interval
      • mr_start
      • thread_safety
      • default_flush_interval

• Struct NetioSubscriberConfig
  • Struct Documentation
    • netio3::NetioSubscriberConfig
      • backend_type
      • backend_mode
      • thread_safety

• Struct PublisherStats
  • Struct Documentation
    • netio3::PublisherStats
      • buffer_stats
      • num_subscriptions

• Struct SubscriptionAcknowledgement
  • Struct Documentation
    • netio3::SubscriptionAcknowledgement
      • tag
      • subscribe
      • to_json()
      • from_json()

• Struct SubscriptionEndpointMap::Hash
  • Nested Relationships
  • Struct Documentation
    • netio3::SubscriptionEndpointMap::Hash
      • operator()()

• Struct SubscriptionRequest
  • Struct Documentation
    • netio3::SubscriptionRequest
      • Sub
        • UNSUBSCRIBE
        • SUBSCRIBE
      • tag
      • addr
      • data_port
      • ack_port
      • subscribe
      • to_json()
      • from_json()

• Class BufferFormatter
  • Class Documentation
    • netio3::BufferFormatter
      • write()
      • write()
      • write()
      • write()
      • reset_buffer()
      • fill_header()
      • decode()
      • HDR_MAX_SIZE
      • HDR_STATUS_FLAG_POS
      • HDR_TAG_FLAG_POS
      • NUM_BIT_PAYLOAD_SIZE
      • MSG_MAX_SIZE

• Template Class NetioPublisherTemplate
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • netio3::NetioPublisherTemplate
      • NetioPublisherTemplate()
      • NetioPublisherTemplate()
      • NetioPublisherTemplate()
      • NetioPublisherTemplate()
      • operator=()
      • operator=()
      • ~NetioPublisherTemplate()
      • publish()
      • publish()
      • publish()
      • publish()
      • flush_buffer()
      • get_endpoint()
      • get_stats()
      • set_on_subscription()
      • set_on_unsubscription()
      • set_on_resource_available()
      • set_on_publish_completed()
      • handle_send_completion()

• Class NetioReceiver
  • Class Documentation
    • netio3::NetioReceiver
      • NetioReceiver()
      • NetioReceiver()
      • NetioReceiver()
      • NetioReceiver()
      • operator=()
      • operator=()
      • ~NetioReceiver()
      • listen()
      • close()
      • set_on_data_cb()
      • set_on_buffer_cb()
      • set_on_connection_established_cb()
      • set_on_connection_closed_cb()

• Class NetioSender
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • netio3::NetioSender
      • NetioSender()
      • NetioSender()
      • NetioSender()
      • NetioSender()
      • operator=()
      • operator=()
      • ~NetioSender()
      • open_connection()
      • close_connection()
      • send_data()
      • send_data()
      • send_data()
      • send_data()
      • send_data()
      • send_data()
      • buffered_send_data()
      • buffered_send_data()
      • buffered_send_data()
      • buffered_send_data()
      • zero_copy_send_data()
      • zero_copy_send_data()
      • zero_copy_send_data()
      • zero_copy_send_data()
      • flush_buffer()
      • get_num_available_buffers()
      • set_on_connection_established()
      • set_on_connection_refused()
      • set_on_connection_closed()
      • set_on_connection_closed_internal()
      • set_on_send_completed()
      • netio3::NetioSender::Connection
        • Connection()
        • Connection()
        • Connection()
        • Connection()
        • operator=()
        • operator=()
        • ~Connection()
        • get_endpoint()

• Class NetioSender::Connection
  • Nested Relationships
  • Class Documentation
    • netio3::NetioSender::Connection
      • Connection()
      • Connection()
      • Connection()
      • Connection()
      • operator=()
      • operator=()
      • ~Connection()
      • get_endpoint()

• Class NetioSubscriber
  • Class Documentation
    • netio3::NetioSubscriber
      • NetioSubscriber()
      • NetioSubscriber()
      • NetioSubscriber()
      • NetioSubscriber()
      • operator=()
      • operator=()
      • ~NetioSubscriber()
      • subscribe()
      • unsubscribe()
      • set_on_subscription_cb()
      • set_on_unsubscription_cb()
      • set_on_data_cb()
      • set_on_buffer_cb()
      • set_on_subscription_lost_cb()

• Class SubscriptionEndpointMap
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • netio3::SubscriptionEndpointMap
      • at()
      • at()
      • contains()
      • erase()
      • add()

• Template Class ConditionalLockGuard
  • Class Documentation
    • netio3::utility::ConditionalLockGuard
      • ConditionalLockGuard()
      • ~ConditionalLockGuard()
      • ConditionalLockGuard()
      • operator=()
      • ConditionalLockGuard()
      • operator=()

• Template Class ConditionalUniqueLock
  • Class Documentation
    • netio3::utility::ConditionalUniqueLock
      • ConditionalUniqueLock()
      • ~ConditionalUniqueLock()
      • lock()
      • unlock()
      • ConditionalUniqueLock()
      • operator=()
      • ConditionalUniqueLock()
      • operator=()

Enums

• Enum DecoderStatus
  • Enum Documentation
    • DecoderStatus
      • OK
      • HEADER_INVALID

• Enum FormatterStatus
  • Enum Documentation
    • FormatterStatus
      • BUFFER_OK
      • BUFFER_READY
      • MESSAGE_TOO_BIG

• Enum NetioPublisherStatus
  • Enum Documentation
    • NetioPublisherStatus
      • OK
      • NO_RESOURCES
      • FAILED
      • NO_SUBSCRIPTIONS
      • PARTIALLY_FAILED

• Enum SendMethod
  • Enum Documentation
    • SendMethod
      • SEND
      • BUFFERED
      • ZERO_COPY

Functions

• Function netio3::formatter_status_string
  • Function Documentation
    • formatter_status_string()

• Function netio3::send_method_from_string
  • Function Documentation
    • send_method_from_string()

Variables

• Variable netio3::SubscriptionEndpointContainer
  • Variable Documentation

Typedefs

• Typedef netio3::CbBufferReceived
  • Typedef Documentation
    • CbBufferReceived

• Typedef netio3::CbMessageReceived
  • Typedef Documentation
    • CbMessageReceived

• Typedef netio3::CbPublishCompleted
  • Typedef Documentation
    • CbPublishCompleted

• Typedef netio3::CbResourceAvailable
  • Typedef Documentation
    • CbResourceAvailable

• Typedef netio3::CbSubscriptionConfirmed
  • Typedef Documentation
    • CbSubscriptionConfirmed

• Typedef netio3::CbSubscriptionLost
  • Typedef Documentation
    • CbSubscriptionLost

• Typedef netio3::CbSubscriptionReceived
  • Typedef Documentation
    • CbSubscriptionReceived

• Typedef netio3::CbUnsubscriptionConfirmed
  • Typedef Documentation
    • CbUnsubscriptionConfirmed

• Typedef netio3::CbUnsubscriptionReceived
  • Typedef Documentation
    • CbUnsubscriptionReceived

• Typedef netio3::NetioPublisher
  • Typedef Documentation
    • NetioPublisher

• Typedef netio3::OnConnectionEstablishedSimpleCb
  • Typedef Documentation
    • OnConnectionEstablishedSimpleCb