API Reference

Preface

This document is an interface reference for Push Framework. It is intended to detail the public classes that constitute the API of the library.

Introduction

Push Framework API is organized in form of public classes. In the code source package of the library these classes reside in a separate folder called: public. In the essentials packages these classes are also found in such folder.
An effort was made in order to avoid the developer having to compile internal library code. That’s why there is wide use of the Pimpl pattern which alleviates the “including” difficulties.

The following is a Doxygen generated documentation based on the in-line commentaries in those classes :

Share