yp-client C++ Header Files

A description of the yp-client .hpp header files follows. These files can be found in /usr/include/yumapro/mgr and /usr/include/yumapro/ycli.

/usr/include/yumapro/mgr C++ Headers

api-devices.hpp

A class representing a Device that this library can connect to, and classes and functions to create, save, load, and modify Devices.

api-exceptions.hpp

The domain-specific exceptions used in the C++ code.

api-filesystem.hpp

A limited version of the std::filesystem library proposed for C++17. Code written against this should work with std::filesystem with minimal changes.

api-session.hpp

A class representing a connected Session, and classes and functions for creating and dealing with Sessions.

api-token.hpp

A class representing a value that is guaranteed to be unique within a run of the program. It is used for several purposes in the API.

api-users.hpp

A class representing a user account on a Device, and classes and functions to create, save, load, and modify Users.

api-xstring.hpp

A string class using unsigned characters, designed to handle XML data, which can also represent a nullptr.

/usr/include/yumapro/ycli C++ Headers

api-grouping.hpp

A class representing a group of objects, typedefs, and subgroups.

api-library.hpp

A class representing a library of module files and allowing you to enumerate, find, and load them.

api-module.hpp

A class representing a Module and describing its interface.

api-object.hpp

A class representing an Object, describing its parameters, type, and any child Objects.

api-typedef.hpp

A class representing a type definition and its parameters.

api-yangapi.hpp

A class representing the API library itself. It handles initialization, cleanup, and general settings of the library.