Skip to main content
Ctrl+K
docs - Home

Interface Documentation

  • Library API
    • Namespace Coral
    • Namespace Coral::Cobs
    • Concept byte_size
    • Concept ifgen_struct
    • Struct BufferState
    • Struct ElementCommandLineApp::Command
    • Struct PcBufferState
    • Template Class BufferLogger
    • Template Class CircularBuffer
    • Template Class MessageDecoder
    • Class MessageEncoder
    • Template Class ContextLock
    • Template Class ElementCommandLine
    • Template Class ElementCommandLineApp
    • 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
    • Class SampleFdBuffer
    • Enum Result
    • Enum TestEnum
    • Function command_handler
    • Function Coral::close_fds
    • Function Coral::Cobs::next_zero_distance
    • Function Coral::dump_buffer
    • Function Coral::dump_fd_status_flags
    • Function Coral::fd_info
    • Function Coral::fd_set_blocking_state
    • Function Coral::from_string
    • Function Coral::get_file_fd
    • Function Coral::get_stdout
    • Template Function Coral::handle_endian(T)
    • Template Function Coral::handle_endian(T)
    • Template Function Coral::handle_endian(T)
    • Template Function Coral::handle_endian(T)
    • Template Function Coral::handle_endian(T)
    • Template Function Coral::handle_endian(T)
    • Template Function Coral::handle_endian_p(T *)
    • Template Function Coral::handle_endian_p(T *)
    • Template Function Coral::handle_endian_p(T *)
    • Template Function Coral::handle_endian_p(T *)
    • Template Function Coral::handle_endian_p(T *)
    • Template Function Coral::handle_endian_p(T *)
    • Template Function Coral::operator<<(std::basic_ostream<element_t>&, PcBuffer<depth, element_t, alignment, Lock>&)
    • Function Coral::operator<<(std::ostream&, Result)
    • Template Function Coral::operator>>
    • Template Function Coral::populate_flag_strs
    • Function Coral::print_verb_name_condition
    • Template Function Coral::register_message_validator
    • Function Coral::stderr_logger
    • Function Coral::to_string
    • Function decoder_scenario
    • Function encoder_scenario
    • Template Function loopback_test
    • Function main(void)
    • Function main(void)
    • Function main(void)
    • Function main(void)
    • Function main(void)
    • Function main(void)
    • Function main(void)
    • Function main(void)
    • Function main(void)
    • Function main(void)
    • Function main(void)
    • Function main(void)
    • Function operator!
    • Function operator<<
    • Function register_commands
    • Template Function struct_test
    • Function test1
    • Function test2
    • Function test_alignment
    • Function test_basic
    • Function test_bools_basic
    • Function test_decoder_contingencies
    • Function test_doubles_basic
    • Function test_drop_data
    • Function test_fail_if
    • Function test_fail_if_not
    • Function test_first_arg_bool
    • Function test_first_arg_float_second_not_float
    • Function test_first_arg_int_second_not_int
    • Function test_first_arg_not_bool
    • Function test_ints_basic
    • Function test_log_fail_if
    • Function test_log_fail_if_not
    • Function test_log_success_if
    • Function test_log_success_if_not
    • Function test_logging
    • Function test_n_push_pop
    • Function test_result
    • Function test_return_if
    • Function test_return_if_not
    • Function test_return_val_if
    • Function test_return_val_if_not
    • Function test_stream_interfaces
    • Function test_string
    • Function test_success_if
    • Function test_success_if_not
    • Function test_zero_distances
    • Function verify_encode_result
    • Variable buffer_size
    • Variable buffer_size
    • Variable Coral::Cobs::zero_pointer_max
    • Variable Coral::default_buffer_depth
    • Variable Coral::default_endian
    • Variable Coral::default_max_args
    • Variable Coral::default_max_commands
    • Variable Coral::default_max_line
    • Variable Coral::default_open_mode
    • Variable Coral::Result_id
    • Variable Coral::static_logger
    • Variable Coral::status_flags
    • Variable depth
    • Variable depth
    • Variable logger
    • Variable message_mtu
    • Variable message_mtu
    • Variable processed
    • Variable value
    • Define CORAL_ENUMS_RESULT_H
    • Define CORAL_IFGEN_COMMON_H
    • Define CORAL_LOGGER
    • Define CORAL_STRUCTS_BUFFERSTATE_H
    • Define FAIL
    • Define FailIf
    • Define FailIfNot
    • Define LogErrno
    • Define LogErrnoIf
    • Define LogErrnoIfNot
    • Define LogErrnoReturnIf
    • Define LogErrnoReturnIfNot
    • Define LogFailIf
    • Define LogFailIfNot
    • Define LogIf
    • Define LogIfNot
    • Define LogReturnIf
    • Define LogReturnIfNot
    • Define LogReturnValIf
    • Define LogReturnValIfNot
    • Define LogSuccessIf
    • Define LogSuccessIfNot
    • Define SUCCESS
    • Define SuccessIf
    • Define SuccessIfNot
    • Define ToBool
    • Define ToResult
    • Typedef Buffer
    • Typedef Buffer
    • Typedef CircBuffer
    • Typedef CommandLine
    • Typedef Coral::byte_array
    • Typedef Coral::byte_istream
    • Typedef Coral::byte_ostream
    • Typedef Coral::byte_span
    • Typedef Coral::byte_spanbuf
    • Typedef Coral::byte_spanstream
    • Typedef Coral::ByteBuffer
    • Typedef Coral::CharBuffer
    • Typedef Coral::CommandLine
    • Typedef Coral::CommandLineApp
    • Typedef Coral::enum_id_t
    • Typedef Coral::FdMap
    • Typedef Coral::struct_id_t
    • Typedef Coral::WcharBuffer
    • Typedef Decoder
    • Typedef Decoder
    • Typedef element_t
    • Typedef Encoder
    • Typedef PcBuf
    • Typedef PcBuf
    • Typedef Processor
  • .rst

File PcBufferState.h

Contents

  • Definition (src/buffer/PcBufferState.h)
  • Includes
  • Included By
  • Namespaces
  • Classes

File PcBufferState.h#

↰ Parent directory (src/buffer)

A class for helping compute producer-consumer buffer state.

Contents

  • Definition (src/buffer/PcBufferState.h)

  • Includes

  • Included By

  • Namespaces

  • Classes

Definition (src/buffer/PcBufferState.h)#

  • Program Listing for File PcBufferState.h

Includes#

  • cstdint

Included By#

  • File PcBuffer.h

Namespaces#

  • Namespace Coral

Classes#

  • Struct PcBufferState

Contents
  • Definition (src/buffer/PcBufferState.h)
  • Includes
  • Included By
  • Namespaces
  • Classes

By Libre Embedded

© Copyright 2026, Libre Embedded.