Google Git
Sign in
chromium / chromiumos / platform2 / libipp / b5ff5d3282b0e1c98c8ac4ca4f9eac30ffe8ff39
commitb5ff5d3282b0e1c98c8ac4ca4f9eac30ffe8ff39[log] [tgz]
authorPiotr Pawliczek <pawliczek@google.com>Mon Apr 03 00:42:41 2023
committerCopybara-Service <copybara-worker@google.com>Tue Apr 04 18:21:19 2023
tree377b0577fa128bef36a11eb8f26a2a8c3d8394b2
parentd9a5f049bce119d34c1ece031fbac1f53a199cda [diff]
libipp: Update documentation about Frame class

Update documentation about Frame class and related classes Collection
and Attribute.

BUG=b:193540670
TEST=none

Change-Id: Ia8c71fe652a3d70056640123148b64434e609412
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform2/+/4393108
Reviewed-by: Benjamin Gordon <bmgordon@chromium.org>
Auto-Submit: Piotr Pawliczek <pawliczek@chromium.org>
Tested-by: Piotr Pawliczek <pawliczek@chromium.org>
Commit-Queue: Piotr Pawliczek <pawliczek@chromium.org>
NOKEYCHECK=True
GitOrigin-RevId: ad218c5be35c3de82cff909e1684659140b5ffa8
2 files changed
tree: 377b0577fa128bef36a11eb8f26a2a8c3d8394b2
  1. docs/
  2. attribute.h
  3. attribute_test.cc
  4. binary_content.cc
  5. binary_content.h
  6. BUILD.gn
  7. builder.cc
  8. builder.h
  9. builder_test.cc
  10. colls_view.cc
  11. colls_view.h
  12. colls_view_test.cc
  13. CPPLINT.cfg
  14. errors.cc
  15. errors.h
  16. errors_test.cc
  17. frame.cc
  18. frame.h
  19. frame_test.cc
  20. ipp_attribute.cc
  21. ipp_attribute.h
  22. ipp_attribute_test.cc
  23. ipp_encoding.h
  24. ipp_encoding_test.cc
  25. ipp_enums.cc
  26. ipp_enums.h
  27. ipp_enums_test.cc
  28. ipp_export.h
  29. ipp_frame.h
  30. ipp_fuzzer.cc
  31. ipp_parser.cc
  32. ipp_parser.h
  33. ipp_test.cc
  34. libipp.pc
  35. OWNERS
  36. parser.cc
  37. parser.h
  38. parser_test.cc
  39. README.md
  40. validator.cc
  41. validator.h
  42. validator_test.cc
README.md

libipp

What is this?

General C++ library for building and parsing IPP frames. IPP stands for Internet Printing Protocol and is defined in several documents. This implementation is based mainly on the following sources:

How to use it?

All required C++ classes, types and functions are declared in ipp namespace.

IPP frames are sent/received as a payload of HTTP POST requests/responses. This library helps to build and parse raw IPP frames, but does not support the HTTP protocol. You have to use some other library to process HTTP packages, like libbrillo or libcurl. You can also dump a raw IPP frame to a file and send it from the command line with curl, e.g.:

curl -X POST "http://my.server:631/mypath" --header "Content-Type: application/ipp" --data-binary @ipp.frame

Then obtained response can be read from the file and parsed by libipp.

Documentation conventions

In this documentation, the following typographical conventions are used:

  • boldface denotes entities defined in the IPP specifications (see the links mentioned above);
  • italics indicates a name of a library or a (shell) command;
  • monospace is used to mark entities from the source code.

Link to documentation