Library API

Class Hierarchy

• Namespace netio3

  • Namespace netio3::asyncmsg

    • Struct ConnectionEvent

    • Class BackendAsyncmsg

      • Struct BackendAsyncmsg::EndpointHash

    • Class Buffer

    • Class BufferManager

    • Class ReceiveMessage

      • Struct ReceiveMessage::Message

      • Struct ReceiveMessage::ReceiveMessageConfig

    • Class SendMessage

    • Class SendMessageBuffered

    • Class SendMessageUnbuffered

    • Class SendMessageUnbufferedCopy

    • Class Server

    • Class Session

    • Enum Mode

  • Namespace netio3::libfabric

    • Struct CqCmFds

    • Struct Endpoint

    • Struct FiInfoDeleter

    • Class BackendLibfabric

    • Class BaseSocket

    • Class Buffer

    • Class ConnectionManager

      • Struct ConnectionManager::CloseQueueItem

      • Struct ConnectionManager::CmEvent

    • Class CqReactor

    • Class DomainContext

    • Class DomainManager

    • Template Class FiCloseDeleter

    • Class FiInfoWrapper

    • Class HeaderBuffer

      • Struct HeaderBuffer::HeaderWrapper

    • Class ListenSocket

    • Class ReceiveSocket

    • Class SendSocket

    • Class SendSocketBuffered

    • Class SendSocketZeroCopy

  • Struct ConnectionParameters

  • Struct ConnectionParametersRecv

  • Struct EndPointAddressHash

  • Struct EventContext

  • Struct NetworkConfig

  • Class AsioEventLoop

  • Class BaseEventLoop

  • Class EndPointAddress

  • Class EpollEventLoop

    • Struct EpollEventLoop::CloseFdQueueItem

  • Class EventSignalHandle

  • Class EventTimerHandle

  • Class NetworkBackend

  • Class NetworkBuffer

  • Template Class ThreadSafeMap

  • Enum NetioStatus

  • Enum NetworkMode

  • Enum NetworkType

  • Enum ThreadSafetyModel

File Hierarchy

• Directory netio3-backend

  • Directory EventLoop

    • File AsioEventLoop.hpp

    • File BaseEventLoop.hpp

    • File EpollEventLoop.hpp

    • File EventSignalHandle.hpp

    • File EventTimerHandle.hpp

    • File Utility.hpp

  • Directory utility

    • File ThreadSafeMap.hpp

  • File Issues.hpp

  • File Netio3Backend.hpp

  • File NetworkBuffer.hpp

• File AsioEventLoop.cpp

• File BackendAsyncmsg.cpp

• File BackendAsyncmsg.hpp

• File BackendLibfabric.cpp

• File BackendLibfabric.hpp

• File BaseEventLoop.cpp

• File BaseSocket.cpp

• File BaseSocket.hpp

• File Buffer.cpp

• File Buffer.cpp

• File Buffer.hpp

• File Buffer.hpp

• File ConnectionManager.cpp

• File ConnectionManager.hpp

• File CqReactor.cpp

• File CqReactor.hpp

• File DomainManager.cpp

• File DomainManager.hpp

• File EpollEventLoop.cpp

• File EventSignalHandle.cpp

• File EventTimerHandle.cpp

• File Helpers.cpp

• File Helpers.hpp

• File Issues.hpp

• File Issues.hpp

• File ListenSocket.cpp

• File ListenSocket.hpp

• File Netio3Backend.cpp

• File ReceiveMessage.cpp

• File ReceiveMessage.hpp

• File ReceiveSocket.cpp

• File ReceiveSocket.hpp

• File SendMessage.hpp

• File SendMessageBuffered.cpp

• File SendMessageBuffered.hpp

• File SendMessageUnbuffered.cpp

• File SendMessageUnbuffered.hpp

• File SendMessageUnbufferedCopy.cpp

• File SendMessageUnbufferedCopy.hpp

• File SendSocket.cpp

• File SendSocket.hpp

• File SendSocketBuffered.cpp

• File SendSocketBuffered.hpp

• File SendSocketZeroCopy.cpp

• File SendSocketZeroCopy.hpp

• File Server.cpp

• File Server.hpp

• File Session.cpp

• File Session.hpp

• File Types.hpp

• File Utility.cpp

Full API

Namespaces

• Namespace felix
  • Namespaces

• Namespace felix::asyncmsg

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

• Namespace netio3::asyncmsg
  • Classes
  • Enums
  • Typedefs

• Namespace netio3::libfabric
  • Classes
  • Functions
  • Typedefs
  • Variables

• Namespace netio3::utility
  • Functions

• Namespace std
  • Namespaces

• Namespace std::chrono_literals

Classes and Structs

• Struct BackendAsyncmsg::EndpointHash
  • Nested Relationships
  • Struct Documentation
    • netio3::asyncmsg::BackendAsyncmsg::EndpointHash
      • hash()
      • equal()

• Struct ConnectionEvent
  • Struct Documentation
    • netio3::asyncmsg::ConnectionEvent
      • Type
        • OPENED
        • REFUSED
        • CLOSED
      • type
      • address

• Struct ReceiveMessage::Message
  • Nested Relationships
  • Struct Documentation
    • netio3::asyncmsg::ReceiveMessage::Message
      • Message()
      • Message()
      • Message()
      • operator=()
      • operator=()
      • ~Message()
      • data

• Struct ReceiveMessage::ReceiveMessageConfig
  • Nested Relationships
  • Struct Documentation
    • netio3::asyncmsg::ReceiveMessage::ReceiveMessageConfig
      • typeId
      • transactionId
      • size

• Struct ConnectionParameters
  • Struct Documentation
    • netio3::ConnectionParameters
      • operator<=>()
      • buf_size
      • num_buf
      • mr_start

• Struct ConnectionParametersRecv
  • Struct Documentation
    • netio3::ConnectionParametersRecv
      • operator<=>()
      • buf_size
      • num_buf

• Struct EndPointAddressHash
  • Struct Documentation
    • netio3::EndPointAddressHash
      • operator()()

• Struct EpollEventLoop::CloseFdQueueItem
  • Nested Relationships
  • Struct Documentation
    • netio3::EpollEventLoop::CloseFdQueueItem
      • fd
      • close_fd
      • wait

• Struct EventContext
  • Struct Documentation
    • netio3::EventContext
      • fd
      • cb
      • on_closed_cb

• Struct ConnectionManager::CloseQueueItem
  • Nested Relationships
  • Struct Documentation
    • netio3::libfabric::ConnectionManager::CloseQueueItem
      • Type
        • listen
        • send
      • address
      • type

• Struct ConnectionManager::CmEvent
  • Nested Relationships
  • Struct Documentation
    • netio3::libfabric::ConnectionManager::CmEvent
      • event
      • err_entry
      • info

• Struct CqCmFds
  • Struct Documentation
    • netio3::libfabric::CqCmFds
      • cq_fd
      • cm_fd

• Struct Endpoint
  • Struct Documentation
    • netio3::libfabric::Endpoint
      • fi
      • rcq
      • cq
      • eq
      • ep
      • eqfd
      • cqfd
      • cq_size

• Struct FiInfoDeleter
  • Struct Documentation
    • netio3::libfabric::FiInfoDeleter
      • operator()()

• Struct HeaderBuffer::HeaderWrapper
  • Nested Relationships
  • Struct Documentation
    • netio3::libfabric::HeaderBuffer::HeaderWrapper
      • status
      • bufnum
      • data

• Struct NetworkConfig
  • Struct Documentation
    • netio3::NetworkConfig
      • mode
      • thread_safety
      • on_data_cb
      • on_connection_established_cb
      • on_connection_closed_cb
      • on_connection_refused_cb
      • on_send_completed_cb
      • operator<<

• Class AsioEventLoop
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • netio3::AsioEventLoop
      • AsioEventLoop()
      • ~AsioEventLoop()
      • AsioEventLoop()
      • operator=()
      • AsioEventLoop()
      • operator=()
      • register_fd()
      • remove_fd()
      • run()
      • run_for()
      • stop()
      • is_running()
      • get_io_context()
      • process_event()

• Class BackendAsyncmsg
  • Nested Relationships
    • Nested Types
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • netio3::asyncmsg::BackendAsyncmsg
      • BackendAsyncmsg()
      • ~BackendAsyncmsg()
      • BackendAsyncmsg()
      • BackendAsyncmsg()
      • operator=()
      • operator=()
      • open_send_endpoint()
      • open_listen_endpoint()
      • close_send_endpoint()
      • close_listen_endpoint()
      • send_data()
      • send_data()
      • send_data_copy()
      • send_data_copy()
      • get_buffer()
      • send_buffer()
      • get_num_available_buffers()

• Class Buffer
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • netio3::asyncmsg::Buffer
      • Buffer()
      • getKey()

• Class BufferManager
  • Class Documentation
    • netio3::asyncmsg::BufferManager
      • BufferManager()
      • getBuffer()
      • returnBuffer()
      • returnBuffer()
      • getNumAvailableBuffers()

• Class ReceiveMessage
  • Nested Relationships
    • Nested Types
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • netio3::asyncmsg::ReceiveMessage
      • ReceiveMessage()
      • toBuffers()
      • typeId()
      • transactionId()
      • msgSize()
      • data()
      • getMessage()
      • netio3::asyncmsg::ReceiveMessage::Message
        • Message()
        • Message()
        • Message()
        • operator=()
        • operator=()
        • ~Message()
        • data
      • netio3::asyncmsg::ReceiveMessage::ReceiveMessageConfig
        • typeId
        • transactionId
        • size

• Class SendMessage
  • Inheritance Relationships
    • Base Type
    • Derived Types
  • Class Documentation
    • netio3::asyncmsg::SendMessage
      • toBuffers()
      • typeId()
      • transactionId()
      • key()

• Class SendMessageBuffered
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • netio3::asyncmsg::SendMessageBuffered
      • SendMessageBuffered()
      • toBuffers()
      • key()

• Class SendMessageUnbuffered
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • netio3::asyncmsg::SendMessageUnbuffered
      • SendMessageUnbuffered()
      • SendMessageUnbuffered()
      • toBuffers()
      • key()

• Class SendMessageUnbufferedCopy
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • netio3::asyncmsg::SendMessageUnbufferedCopy
      • SendMessageUnbufferedCopy()
      • SendMessageUnbufferedCopy()
      • toBuffers()
      • key()

• Class Server
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • netio3::asyncmsg::Server
      • Server()
      • startAccept()
      • onAccept()
      • onAcceptError()
      • shutdown()

• Class Session
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • netio3::asyncmsg::Session
      • Session()
      • sendData()
      • onOpen()
      • onOpenError()
      • createMessage()
      • onReceive()
      • onReceiveError()
      • onSend()
      • onSendError()
      • onClose()
      • onCloseError()
      • getBuffer()
      • getNumAvailableBuffers()
      • getPendingSends()

• Class BaseEventLoop
  • Inheritance Relationships
    • Base Type
    • Derived Types
  • Class Documentation
    • netio3::BaseEventLoop
      • BaseEventLoop()
      • ~BaseEventLoop()
      • BaseEventLoop()
      • operator=()
      • BaseEventLoop()
      • operator=()
      • register_fd()
      • remove_fd()
      • run()
      • run_for()
      • stop()
      • is_running()
      • get_thread_id()
      • create_signal()
      • remove_signal()
      • create_timer()
      • remove_timer()
      • set_thread_id()
      • reset_thread_id()
      • wait_for_fd()
      • update_flags()
      • check_fd()

• Class EndPointAddress
  • Class Documentation
    • netio3::EndPointAddress
      • EndPointAddress()
      • EndPointAddress()
      • EndPointAddress()
      • address()
      • port()
      • address_numeric()
      • port()
      • operator<=>()
      • operator==()
      • operator!=()
      • operator<<
      • AbslHashValue

• Class EpollEventLoop
  • Nested Relationships
    • Nested Types
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • netio3::EpollEventLoop
      • EpollEventLoop()
      • ~EpollEventLoop()
      • EpollEventLoop()
      • operator=()
      • EpollEventLoop()
      • operator=()
      • run()
      • run_for()
      • register_fd()
      • remove_fd()
      • stop()
      • is_running()

• Class EventSignalHandle
  • Class Documentation
    • netio3::EventSignalHandle
      • EventSignalHandle()
      • ~EventSignalHandle()
      • EventSignalHandle()
      • EventSignalHandle()
      • operator=()
      • operator=()
      • fire()
      • get_fd()

• Class EventTimerHandle
  • Class Documentation
    • netio3::EventTimerHandle
      • EventTimerHandle()
      • ~EventTimerHandle()
      • EventTimerHandle()
      • EventTimerHandle()
      • operator=()
      • operator=()
      • start()
      • stop()
      • get_fd()
      • is_running()

• Class BackendLibfabric
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • netio3::libfabric::BackendLibfabric
      • BackendLibfabric()
      • open_send_endpoint()
      • open_listen_endpoint()
      • close_send_endpoint()
      • close_listen_endpoint()
      • send_data()
      • send_data()
      • send_data_copy()
      • send_data_copy()
      • get_buffer()
      • send_buffer()
      • get_num_available_buffers()

• Class BaseSocket
  • Inheritance Relationships
    • Derived Types
  • Class Documentation
    • netio3::libfabric::BaseSocket
      • get_endpoint()
      • get_endpoint()
      • get_cq_cm_fds()
      • set_cq_ev_ctx()
      • set_eq_ev_ctx()
      • get_eq_ev_ctx()
      • get_cq_ev_ctx()
      • BaseSocket()
      • open_endpoint()
      • enable_endpoint()
      • prepare_cq_attr()
      • register_buffer()
      • close_buffer()

• Class Buffer
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • netio3::libfabric::Buffer
      • Buffer()
      • Buffer()
      • get_buffer()
      • get_size()
      • get_domain()
      • get_key()
      • mr

• Class ConnectionManager
  • Nested Relationships
    • Nested Types
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • netio3::libfabric::ConnectionManager
      • ConnectionManager()
      • ~ConnectionManager()
      • ConnectionManager()
      • ConnectionManager()
      • operator=()
      • operator=()
      • init()
      • open_listen_endpoint()
      • open_send_endpoint_buffered()
      • open_send_endpoint_zero_copy()
      • close_listen_endpoint()
      • close_send_endpoint()
      • get_num_available_buffers()
      • apply_to_send_socket_buffered()
      • apply_to_send_socket_zero_copy()
      • create()

• Class CqReactor
  • Class Documentation
    • netio3::libfabric::CqReactor
      • CqReactor()
      • on_send_socket_cq_event()
      • on_recv_socket_cq_event()

• Class DomainContext
  • Class Documentation
    • netio3::libfabric::DomainContext
      • DomainContext()
      • get_domain()
      • get_domain()

• Class DomainManager
  • Class Documentation
    • netio3::libfabric::DomainManager
      • DomainManager()
      • ~DomainManager()
      • DomainManager()
      • DomainManager()
      • operator=()
      • operator=()
      • get_fabric()
      • get_fabric()
      • get_listen_domain()
      • get_listen_domain()
      • get_send_domain()
      • get_send_domain()

• Template Class FiCloseDeleter
  • Class Documentation
    • netio3::libfabric::FiCloseDeleter
      • FiCloseDeleter()
      • operator()()

• Class FiInfoWrapper
  • Class Documentation
    • netio3::libfabric::FiInfoWrapper
      • FiInfoWrapper()
      • get()

• Class HeaderBuffer
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • netio3::libfabric::HeaderBuffer
      • HeaderBuffer()
      • get_header()
      • return_header()
      • get_buffer()
      • get_size()
      • get_domain()
      • get_num_available_buffers()
      • get_pending_sends()
      • mr
      • netio3::libfabric::HeaderBuffer::HeaderWrapper
        • status
        • bufnum
        • data

• Class ListenSocket
  • Class Documentation
    • netio3::libfabric::ListenSocket
      • ListenSocket()
      • get_address()
      • get_connection_parameters()
      • get_endpoint()
      • get_endpoint()
      • get_cq_cm_fds()
      • get_pep()
      • get_pep()
      • set_eq_ev_ctx()

• Class ReceiveSocket
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • netio3::libfabric::ReceiveSocket
      • ReceiveSocket()
      • ReceiveSocket()
      • ReceiveSocket()
      • operator=()
      • operator=()
      • ~ReceiveSocket()
      • operator<=>()
      • post_buffers()
      • post_buffer()

• Class SendSocket
  • Inheritance Relationships
    • Base Type
    • Derived Types
  • Class Documentation
    • netio3::libfabric::SendSocket
      • get_address()
      • SendSocket()
      • init()
      • send_data()
      • send_data()

• Class SendSocketBuffered
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • netio3::libfabric::SendSocketBuffered
      • SendSocketBuffered()
      • SendSocketBuffered()
      • SendSocketBuffered()
      • operator=()
      • operator=()
      • ~SendSocketBuffered()
      • operator<=>()
      • get_buffer()
      • send_buffer()
      • release_buffer()
      • get_num_available_buffers()
      • get_pending_sends()

• Class SendSocketZeroCopy
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • netio3::libfabric::SendSocketZeroCopy
      • SendSocketZeroCopy()
      • SendSocketZeroCopy()
      • SendSocketZeroCopy()
      • operator=()
      • operator=()
      • ~SendSocketZeroCopy()
      • operator<=>()
      • send_data()
      • send_data()
      • release_buffer()
      • get_num_available_buffers()
      • get_pending_sends()

• Class NetworkBackend
  • Inheritance Relationships
    • Derived Types
  • Class Documentation
    • netio3::NetworkBackend
      • NetworkBackend()
      • ~NetworkBackend()
      • NetworkBackend()
      • NetworkBackend()
      • operator=()
      • operator=()
      • open_send_endpoint()
      • open_listen_endpoint()
      • close_send_endpoint()
      • close_listen_endpoint()
      • send_data()
      • send_data()
      • send_data_copy()
      • send_data_copy()
      • get_buffer()
      • send_buffer()
      • get_num_available_buffers()
      • create()
      • m_config
      • m_evloop

• Class NetworkBuffer
  • Inheritance Relationships
    • Derived Types
  • Class Documentation
    • netio3::NetworkBuffer
      • NetworkBuffer()
      • NetworkBuffer()
      • ~NetworkBuffer()
      • NetworkBuffer()
      • NetworkBuffer()
      • operator=()
      • operator=()
      • write()
      • write()
      • write()
      • reset()
      • data()
      • data()
      • size()
      • pos()
      • mark_as_full()
      • set_pos()
      • shuffle_to_front()
      • shuffle_to_front2()

• Template Class ThreadSafeMap
  • Class Documentation
    • netio3::ThreadSafeMap
      • ThreadSafeMap()
      • try_emplace()
      • try_emplace()
      • erase()
      • clear()
      • size()
      • empty()
      • contains()
      • apply()
      • apply()
      • apply_all()
      • apply_all()

Enums

• Enum Mode
  • Enum Documentation
    • Mode
      • POLL
      • POLL_ONE
      • STANDALONE
      • DELEGATE

• Enum NetioStatus
  • Enum Documentation
    • NetioStatus
      • OK
      • NO_RESOURCES
      • FAILED

• Enum NetworkMode
  • Enum Documentation
    • NetworkMode
      • TCP
      • RDMA

• Enum NetworkType
  • Enum Documentation
    • NetworkType
      • LIBFABRIC
      • ASYNCMSG

• Enum ThreadSafetyModel
  • Enum Documentation
    • ThreadSafetyModel
      • SAFE
      • UNSAFE

Functions

• Function netio3::libfabric::BaseSocket::close_buffer< netio3::libfabric::Buffer >
  • Function Documentation

• Function netio3::libfabric::BaseSocket::close_buffer< netio3::libfabric::HeaderBuffer >
  • Function Documentation

• Function netio3::libfabric::BaseSocket::register_buffer< netio3::libfabric::Buffer >
  • Function Documentation

• Function netio3::libfabric::BaseSocket::register_buffer< netio3::libfabric::HeaderBuffer >
  • Function Documentation

• Function netio3::libfabric::ConnectionManager::on_send_socket_cm_event< netio3::libfabric::SendSocketBuffered >
  • Function Documentation

• Function netio3::libfabric::ConnectionManager::on_send_socket_cm_event< netio3::libfabric::SendSocketZeroCopy >
  • Function Documentation

• Function netio3::libfabric::CqReactor::on_send_socket_cq_event< netio3::libfabric::SendSocketBuffered >
  • Function Documentation

• Function netio3::libfabric::CqReactor::on_send_socket_cq_event< netio3::libfabric::SendSocketZeroCopy >
  • Function Documentation

• Function netio3::libfabric::get_provider
  • Function Documentation
    • get_provider()

• Function netio3::libfabric::peer_address
  • Function Documentation
    • peer_address()

• Function netio3::network_mode_from_string
  • Function Documentation
    • network_mode_from_string()

• Function netio3::network_type_from_string
  • Function Documentation
    • network_type_from_string()

• Function netio3::operator<<(std::ostream&, const EndPointAddress&)
  • Function Documentation
    • operator<<()

• Function netio3::operator<<(std::ostream&, const NetworkConfig&)
  • Function Documentation
    • operator<<()

• Function netio3::utility::error_message
  • Function Documentation
    • error_message()

• Function operator<<
  • Function Documentation
    • operator<<()

Variables

• Variable netio3::ChronoDuration
  • Variable Documentation

• Variable netio3::libfabric::BufferConcept
  • Variable Documentation

• Variable netio3::libfabric::HasFidConcept
  • Variable Documentation

• Variable netio3::libfabric::MAX_CQ_ENTRIES
  • Variable Documentation
    • MAX_CQ_ENTRIES

• Variable netio3::libfabric::MAX_CQ_EVENTS
  • Variable Documentation
    • MAX_CQ_EVENTS

• Variable netio3::libfabric::SendSocketConcept
  • Variable Documentation

• Variable netio3::ZERO_COPY_MAX_SIZE_USER_DATA
  • Variable Documentation
    • ZERO_COPY_MAX_SIZE_USER_DATA

• Variable netio3::ZERO_COPY_NUM_HEADER_SLOTS
  • Variable Documentation
    • ZERO_COPY_NUM_HEADER_SLOTS

• Variable netio3::ZERO_COPY_SIZE_HEADER
  • Variable Documentation
    • ZERO_COPY_SIZE_HEADER

Typedefs

• Typedef netio3::asyncmsg::Key
  • Typedef Documentation
    • Key

• Typedef netio3::libfabric::FiCloseUniquePtr
  • Typedef Documentation
    • FiCloseUniquePtr

• Typedef netio3::libfabric::FiInfoUniquePtr
  • Typedef Documentation
    • FiInfoUniquePtr

• Typedef netio3::libfabric::Header
  • Typedef Documentation
    • Header

• Typedef netio3::OnConnectionClosedCb
  • Typedef Documentation
    • OnConnectionClosedCb

• Typedef netio3::OnConnectionClosedKeysCb
  • Typedef Documentation
    • OnConnectionClosedKeysCb

• Typedef netio3::OnConnectionEstablishedCb
  • Typedef Documentation
    • OnConnectionEstablishedCb

• Typedef netio3::OnConnectionRefusedCb
  • Typedef Documentation
    • OnConnectionRefusedCb

• Typedef netio3::OnDataCb
  • Typedef Documentation
    • OnDataCb

• Typedef netio3::OnSendCompleted
  • Typedef Documentation
    • OnSendCompleted