Library API

Class Hierarchy

• • Namespace Coral
    • Namespace Coral::Cobs
      • Template Class MessageDecoder
      • Class MessageEncoder
    • Struct BufferState
    • Struct PcBufferState
    • Template Class BufferLogger
    • Template Class CircularBuffer
    • Template Class ContextLock
    • Template Class ElementCommandLine
    • Template Class ElementCommandLineApp
      • Struct ElementCommandLineApp::Command
    • Class FdManager
    • Class FdPrintfLogger
    • Template Class FullDuplexBuffer
    • Template Class HasLogInterface
    • Template Class LogInterface
    • Template Class MessageBuffer
      • Class MessageBuffer::MessageContext
    • Class NoopLock
    • Template Class PcBuffer
    • Template Class PcBufferReader
    • Template Class PcBufferWriter
    • Class PrintfLogger
    • Template Class StringCommandProcessor
    • Enum Result
  • Class SampleFdBuffer
  • Enum TestEnum

File Hierarchy

• • Directory src
    • Directory apps
      • Directory buffer
        • Directory cobs
          • File test_cobs_decoder.cc
          • File test_cobs_encode_decode.cc
          • File test_cobs_encoder.cc
        • File common.h
        • File SampleFdBuffer.h
        • File test_full_duplex_buffer.cc
        • File test_message_buffer.cc
        • File test_pc_buffer.cc
      • Directory cli
        • File common.h
        • File test_command_line.cc
        • File test_command_line_app.cc
        • File test_string_command_processor.cc
      • Directory generated
        • Directory ifgen
          • File test_common.cc
      • Directory io
        • File test_fd.cc
      • Directory logging
        • File test_logger.cc
    • Directory buffer
      • Directory cobs
        • File debug.cc
        • File debug.h
        • File Decoder.h
        • File Encoder.cc
        • File Encoder.h
      • File CircularBuffer.h
      • File FullDuplexBuffer.h
      • File MessageBuffer.h
      • File PcBuffer.h
      • File PcBufferReader.h
      • File PcBufferState.h
      • File PcBufferWriter.h
    • Directory cli
      • File CommandLine.h
      • File CommandLineApp.h
      • File StringCommandProcessor.h
      • File text.cc
      • File text.h
    • Directory generated
      • Directory enums
        • File Result.h
      • Directory ifgen
        • File common.h
      • Directory structs
        • File BufferState.h
    • Directory io
      • File FdManager.cc
      • File FdManager.h
      • File file_descriptors.cc
      • File file_descriptors.h
    • Directory logging
      • File BufferLogger.h
      • File LogInterface.h
      • File macros.h
      • File PrintfLogger.cc
      • File PrintfLogger.h
    • File ContextLock.h
    • File result.h

Full API

Namespaces

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

• Namespace Coral::Cobs
  • Classes
  • Functions
  • Variables

Concepts

• Concept byte_size
  • Concept Documentation
    • byte_size

• Concept ifgen_struct
  • Concept Documentation
    • ifgen_struct

Classes and Structs

• Struct BufferState
  • Struct Documentation
    • Coral::BufferState
      • Buffer
      • Span
      • operator<=>()
      • raw()
      • span()
      • raw_ro()
      • endian()
      • encode()
      • decode()
      • write_cursor
      • read_cursor
      • read_count
      • write_count
      • id
      • size

• Struct ElementCommandLineApp::Command
  • Nested Relationships
  • Struct Documentation
    • Coral::ElementCommandLineApp::Command
      • handle()
      • command
      • handler
      • help

• Struct PcBufferState
  • Struct Documentation
    • Coral::PcBufferState
      • PcBufferState()
      • reset()
      • has_enough_space()
      • increment_data()
      • has_enough_data()
      • decrement_data()
      • poll_metrics()
      • empty()
      • full()
      • data_available()
      • space_available()
      • size
      • data
      • space
      • high_watermark
      • write_dropped

• Template Class BufferLogger
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Coral::BufferLogger
      • String
      • Handler
      • BufferLogger()
      • vlog_impl()
      • handler
      • data

• Template Class CircularBuffer
  • Inheritance Relationships
    • Derived Type
  • Class Documentation
    • Coral::CircularBuffer
      • CircularBuffer()
      • write()
      • write()
      • write()
      • read()
      • read()
      • read()
      • write_single()
      • write_n()
      • peek()
      • read_single()
      • read_single()
      • read_n()
      • poll_metrics()
      • write_count()
      • read_count()
      • reset()
      • head()
      • Depth
      • write_index()
      • read_index()
      • buffer
      • state

• Template Class MessageDecoder
  • Class Documentation
    • Coral::Cobs::MessageDecoder
      • Array
      • MessageCallback
      • MessageDecoder()
      • set_message_callback()
      • dispatch()
      • stats()
      • callback
      • service_callback()
      • reset()
      • discard()
      • add_to_message()
      • message
      • message_index
      • message_breached_mtu
      • zero_pointer
      • zero_pointer_overhead
      • bytes_dropped
      • message_count
      • stats_new

• Class MessageEncoder
  • Class Documentation
    • Coral::Cobs::MessageEncoder
      • MessageEncoder()
      • stage()
      • stage()
      • stage()
      • encode()
      • stats()
      • State
        • not_initialized
        • start
        • encode_zero
        • encode_data
        • encode_delimeter
        • complete
      • ZeroPointerState
        • empty
        • pointer_to_data
        • pointer_to_end
        • pointer_to_pointer
      • advance_message()
      • handle_zero_pointer()
      • handle_encode_zero()
      • handle_encode_data()
      • pointer_kind()
      • data
      • length
      • bytes_sent
      • messages_sent
      • stats_new
      • state
      • zero_pointer_state
      • last_pointer_kind
      • zero_pointer

• Template Class ContextLock
  • Class Documentation
    • Coral::ContextLock
      • ContextLock()
      • ~ContextLock()

• Template Class ElementCommandLine
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Coral::ElementCommandLine
      • String
      • ElementCommandLine()
      • as_long()
      • as_double()
      • as_bool()
      • at()
      • get_command()
      • line
      • command
      • length

• Template Class ElementCommandLineApp
  • Nested Relationships
    • Nested Types
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Coral::ElementCommandLineApp
      • CommandLine
      • Processor
      • Handler
      • CommandRegistration
      • ElementCommandLineApp()
      • add_handler()
      • process()
      • help()
      • processor
      • commands
      • command_index
      • Coral::ElementCommandLineApp::Command
        • handle()
        • command
        • handler
        • help

• Class FdManager
  • Class Documentation
    • Coral::FdManager
      • FdGroup
      • FdManager()
      • ~FdManager()
      • add_file_fd()
      • fd_group()
      • add_fd()
      • operator[]()
      • default_group
      • groups

• Class FdPrintfLogger
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Coral::FdPrintfLogger
      • FdPrintfLogger()
      • vlog_impl()
      • fd

• Template Class FullDuplexBuffer
  • Class Documentation
    • Coral::FullDuplexBuffer
      • TxBuffer
      • RxBuffer
      • FullDuplexBuffer()
      • dispatch()
      • service_tx()
      • service_rx()
      • tx
      • rx

• Template Class HasLogInterface
  • Inheritance Relationships
    • Derived Types
  • Class Documentation
    • Coral::HasLogInterface
      • Logger
      • HasLogInterface()
      • normalize_log()
      • logger

• Template Class LogInterface
  • Inheritance Relationships
    • Derived Type
  • Class Documentation
    • Coral::LogInterface
      • va_start()
      • vlog()
      • va_end()
      • vlog()

• Template Class MessageBuffer
  • Nested Relationships
    • Nested Types
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Coral::MessageBuffer
      • MessageBuffer()
      • context()
      • space()
      • full()
      • put_message()
      • get_message()
      • empty()
      • clear()
      • add_message()
      • remove_message()
      • message_sizes
      • num_messages
      • data_size
      • locked
      • Coral::MessageBuffer::MessageContext
        • MessageContext()
        • ~MessageContext()
        • custom()
        • point()
        • max
        • buf

• Class MessageBuffer::MessageContext
  • Nested Relationships
  • Class Documentation
    • Coral::MessageBuffer::MessageContext
      • MessageContext()
      • ~MessageContext()
      • custom()
      • point()
      • max
      • buf

• Class NoopLock
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Coral::NoopLock
      • lock()
      • unlock()

• Template Class PcBuffer
  • Inheritance Relationships
    • Base Types
  • Class Documentation
    • Coral::PcBuffer
      • ServiceCallback
      • PcBuffer()
      • set_space_available()
      • set_data_available()
      • empty()
      • full()
      • clear()
      • peek()
      • pop_impl()
      • pop_n_impl()
      • try_pop_n_impl()
      • pop_all_impl()
      • push_impl()
      • push_blocking_impl()
      • flush()
      • push_n_impl()
      • try_push_n_impl()
      • push_n_blocking_impl()
      • head()
      • state
      • Depth
      • service_data()
      • service_space()
      • buffer
      • space_available
      • data_available
      • auto_service

• Template Class PcBufferReader
  • Inheritance Relationships
    • Derived Types
  • Class Documentation
    • Coral::PcBufferReader
      • pop()
      • pop()
      • pop()
      • pop_n()
      • try_pop_n()
      • try_pop_n()
      • try_pop_n()
      • pop_all()

• Template Class PcBufferWriter
  • Inheritance Relationships
    • Derived Types
  • Class Documentation
    • Coral::PcBufferWriter
      • push()
      • push_blocking()
      • push()
      • push()
      • push_n()
      • try_push_n()
      • try_push_n()
      • try_push_n()
      • push_n_blocking()
      • push_n_blocking()
      • push_n_blocking()

• Class PrintfLogger
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Coral::PrintfLogger
      • vlog_impl()

• Template Class StringCommandProcessor
  • Class Documentation
    • Coral::StringCommandProcessor
      • Buffer
      • String
      • Handler
      • StringCommandProcessor()
      • set_auto_poll()
      • set_handler()
      • reset()
      • poll()
      • process()
      • process()
      • process()
      • handler
      • null
      • default_line_delim
      • default_word_delim
      • input
      • line_delim
      • line
      • index
      • word_delim
      • args
      • num_args

• Class SampleFdBuffer
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • SampleFdBuffer
      • service_tx_impl()
      • service_rx_impl()

Enums

• Enum Result
  • Enum Documentation
    • Result
      • Fail
      • Success

• Enum TestEnum
  • Enum Documentation

Functions

• Function command_handler
  • Function Documentation

• Function Coral::close_fds
  • Function Documentation
    • close_fds()

• Function Coral::Cobs::next_zero_distance
  • Function Documentation
    • next_zero_distance()

• Function Coral::dump_buffer
  • Function Documentation
    • dump_buffer()

• Function Coral::dump_fd_status_flags
  • Function Documentation
    • dump_fd_status_flags()

• Function Coral::fd_info
  • Function Documentation
    • fd_info()

• Function Coral::fd_set_blocking_state
  • Function Documentation
    • fd_set_blocking_state()

• Function Coral::from_string
  • Function Documentation
    • from_string()

• Function Coral::get_file_fd
  • Function Documentation
    • get_file_fd()

• Function Coral::get_stdout
  • Function Documentation
    • get_stdout()

• Template Function Coral::handle_endian(T)
  • Function Documentation

• Template Function Coral::handle_endian(T)
  • Function Documentation

• Template Function Coral::handle_endian(T)
  • Function Documentation

• Template Function Coral::handle_endian(T)
  • Function Documentation

• Template Function Coral::handle_endian(T)
  • Function Documentation

• Template Function Coral::handle_endian(T)
  • Function Documentation

• Template Function Coral::handle_endian_p(T *)
  • Function Documentation

• Template Function Coral::handle_endian_p(T *)
  • Function Documentation

• Template Function Coral::handle_endian_p(T *)
  • Function Documentation

• Template Function Coral::handle_endian_p(T *)
  • Function Documentation

• Template Function Coral::handle_endian_p(T *)
  • Function Documentation

• Template Function Coral::handle_endian_p(T *)
  • Function Documentation

• Template Function Coral::operator<<(std::basic_ostream<element_t>&, PcBuffer<depth, element_t, alignment, Lock>&)
  • Function Documentation

• Function Coral::operator<<(std::ostream&, Result)
  • Function Documentation
    • operator<<()

• Template Function Coral::operator>>
  • Function Documentation

• Template Function Coral::populate_flag_strs
  • Function Documentation
    • populate_flag_strs()

• Function Coral::print_verb_name_condition
  • Function Documentation
    • print_verb_name_condition()

• Template Function Coral::register_message_validator
  • Function Documentation
    • register_message_validator()

• Function Coral::stderr_logger
  • Function Documentation
    • stderr_logger()

• Function Coral::to_string
  • Function Documentation
    • to_string()

• Function decoder_scenario
  • Function Documentation

• Function encoder_scenario
  • Function Documentation

• Template Function loopback_test
  • Function Documentation

• Function main(void)
  • Function Documentation

• Function main(void)
  • Function Documentation

• Function main(void)
  • Function Documentation

• Function main(void)
  • Function Documentation

• Function main(void)
  • Function Documentation

• Function main(void)
  • Function Documentation

• Function main(void)
  • Function Documentation

• Function main(void)
  • Function Documentation

• Function main(void)
  • Function Documentation

• Function main(void)
  • Function Documentation

• Function main(void)
  • Function Documentation

• Function main(void)
  • Function Documentation

• Function operator!
  • Function Documentation
    • operator!()

• Function operator<<
  • Function Documentation

• Function register_commands
  • Function Documentation

• Template Function struct_test
  • Function Documentation

• Function test1
  • Function Documentation

• Function test2
  • Function Documentation

• Function test_alignment
  • Function Documentation

• Function test_basic
  • Function Documentation

• Function test_bools_basic
  • Function Documentation

• Function test_decoder_contingencies
  • Function Documentation

• Function test_doubles_basic
  • Function Documentation

• Function test_drop_data
  • Function Documentation

• Function test_fail_if
  • Function Documentation

• Function test_fail_if_not
  • Function Documentation

• Function test_first_arg_bool
  • Function Documentation

• Function test_first_arg_float_second_not_float
  • Function Documentation

• Function test_first_arg_int_second_not_int
  • Function Documentation

• Function test_first_arg_not_bool
  • Function Documentation

• Function test_ints_basic
  • Function Documentation

• Function test_log_fail_if
  • Function Documentation

• Function test_log_fail_if_not
  • Function Documentation

• Function test_log_success_if
  • Function Documentation

• Function test_log_success_if_not
  • Function Documentation

• Function test_logging
  • Function Documentation

• Function test_n_push_pop
  • Function Documentation

• Function test_result
  • Function Documentation

• Function test_return_if
  • Function Documentation

• Function test_return_if_not
  • Function Documentation

• Function test_return_val_if
  • Function Documentation

• Function test_return_val_if_not
  • Function Documentation

• Function test_stream_interfaces
  • Function Documentation

• Function test_string
  • Function Documentation

• Function test_success_if
  • Function Documentation

• Function test_success_if_not
  • Function Documentation

• Function test_zero_distances
  • Function Documentation

• Function verify_encode_result
  • Function Documentation

Variables

• Variable buffer_size
  • Variable Documentation

• Variable buffer_size
  • Variable Documentation

• Variable Coral::Cobs::zero_pointer_max
  • Variable Documentation
    • zero_pointer_max

• Variable Coral::default_buffer_depth
  • Variable Documentation
    • default_buffer_depth

• Variable Coral::default_endian
  • Variable Documentation
    • default_endian

• Variable Coral::default_max_args
  • Variable Documentation
    • default_max_args

• Variable Coral::default_max_commands
  • Variable Documentation
    • default_max_commands

• Variable Coral::default_max_line
  • Variable Documentation
    • default_max_line

• Variable Coral::default_open_mode
  • Variable Documentation
    • default_open_mode

• Variable Coral::Result_id
  • Variable Documentation
    • Result_id

• Variable Coral::static_logger
  • Variable Documentation
    • static_logger

• Variable Coral::status_flags
  • Variable Documentation
    • status_flags

• Variable depth
  • Variable Documentation
    • depth

• Variable depth
  • Variable Documentation
    • depth

• Variable logger
  • Variable Documentation
    • logger

• Variable message_mtu
  • Variable Documentation

• Variable message_mtu
  • Variable Documentation

• Variable processed
  • Variable Documentation

• Variable value
  • Variable Documentation

Defines

• Define CORAL_ENUMS_RESULT_H
  • Define Documentation
    • CORAL_ENUMS_RESULT_H

• Define CORAL_IFGEN_COMMON_H
  • Define Documentation
    • CORAL_IFGEN_COMMON_H

• Define CORAL_LOGGER
  • Define Documentation
    • CORAL_LOGGER

• Define CORAL_STRUCTS_BUFFERSTATE_H
  • Define Documentation
    • CORAL_STRUCTS_BUFFERSTATE_H

• Define FAIL
  • Define Documentation
    • FAIL

• Define FailIf
  • Define Documentation
    • FailIf

• Define FailIfNot
  • Define Documentation
    • FailIfNot

• Define LogErrno
  • Define Documentation
    • LogErrno

• Define LogErrnoIf
  • Define Documentation
    • LogErrnoIf

• Define LogErrnoIfNot
  • Define Documentation
    • LogErrnoIfNot

• Define LogErrnoReturnIf
  • Define Documentation
    • LogErrnoReturnIf

• Define LogErrnoReturnIfNot
  • Define Documentation
    • LogErrnoReturnIfNot

• Define LogFailIf
  • Define Documentation
    • LogFailIf

• Define LogFailIfNot
  • Define Documentation
    • LogFailIfNot

• Define LogIf
  • Define Documentation
    • LogIf

• Define LogIfNot
  • Define Documentation
    • LogIfNot

• Define LogReturnIf
  • Define Documentation
    • LogReturnIf

• Define LogReturnIfNot
  • Define Documentation
    • LogReturnIfNot

• Define LogReturnValIf
  • Define Documentation
    • LogReturnValIf

• Define LogReturnValIfNot
  • Define Documentation
    • LogReturnValIfNot

• Define LogSuccessIf
  • Define Documentation
    • LogSuccessIf

• Define LogSuccessIfNot
  • Define Documentation
    • LogSuccessIfNot

• Define SUCCESS
  • Define Documentation
    • SUCCESS

• Define SuccessIf
  • Define Documentation
    • SuccessIf

• Define SuccessIfNot
  • Define Documentation
    • SuccessIfNot

• Define ToBool
  • Define Documentation
    • ToBool

• Define ToResult
  • Define Documentation
    • ToResult

Typedefs

• Typedef Buffer
  • Typedef Documentation
    • Buffer

• Typedef Buffer
  • Typedef Documentation
    • Buffer

• Typedef CircBuffer
  • Typedef Documentation

• Typedef CommandLine
  • Typedef Documentation
    • CommandLine

• Typedef Coral::byte_array
  • Typedef Documentation
    • byte_array

• Typedef Coral::byte_istream
  • Typedef Documentation
    • byte_istream

• Typedef Coral::byte_ostream
  • Typedef Documentation
    • byte_ostream

• Typedef Coral::byte_span
  • Typedef Documentation
    • byte_span

• Typedef Coral::byte_spanbuf
  • Typedef Documentation
    • byte_spanbuf

• Typedef Coral::byte_spanstream
  • Typedef Documentation
    • byte_spanstream

• Typedef Coral::ByteBuffer
  • Typedef Documentation
    • ByteBuffer

• Typedef Coral::CharBuffer
  • Typedef Documentation
    • CharBuffer

• Typedef Coral::CommandLine
  • Typedef Documentation
    • CommandLine

• Typedef Coral::CommandLineApp
  • Typedef Documentation
    • CommandLineApp

• Typedef Coral::enum_id_t
  • Typedef Documentation
    • enum_id_t

• Typedef Coral::FdMap
  • Typedef Documentation
    • FdMap

• Typedef Coral::struct_id_t
  • Typedef Documentation
    • struct_id_t

• Typedef Coral::WcharBuffer
  • Typedef Documentation
    • WcharBuffer

• Typedef Decoder
  • Typedef Documentation

• Typedef Decoder
  • Typedef Documentation

• Typedef element_t
  • Typedef Documentation
    • element_t

• Typedef Encoder
  • Typedef Documentation

• Typedef PcBuf
  • Typedef Documentation

• Typedef PcBuf
  • Typedef Documentation

• Typedef Processor
  • Typedef Documentation
    • Processor