Skip to content

API Reference

Hand-written reference pages for each public class. They cover the methods you actually call from user code; for the full class-and-member view (private members, inheritance, file groupings) see Doxygen.

Pages

  • Reader — hipo::reader, hipo::readerIndex. Open files, iterate events, jump to a specific event/record, tag filtering, banklist convenience.
  • Writer — hipo::writer. Schema registration, dictionary copy, user config, event flushing.
  • Bank — typed columnar table. getInt/getFloat/…, putInt/putFloat/…, rows, schema introspection, row lists.
  • Event — concatenated structures with a 16-byte header. Reading banks out of an event, building events for writing, tags.
  • Schema — column definitions, parsing schema strings, getEntryOrder for column-index caching.
  • Record — the LZ4-compressed I/O unit. Direct record-level access for power users.
  • Chain — multi-file processing with parallel and sequential modes.
  • Utilities — hipoeventfile, parser, fusion, tuple, helpers.

Conventions

  • All public types live in namespace hipo.
  • Headers under hipo4/*.h. Include the one matching the class you need (reader.h, writer.h, bank.h, …).
  • Method signatures shown on these pages are simplified for readability — the source in hipo4/ is authoritative.