Agenda Server Client Side Overview

The client side interface to the agenda server. The agenda server manages access to agenda files by one or more clients. Although it is possible for applications to avoid using the server so that agenda data is accessed directly, it is recommended that the server is always used.

The Agenda Server Client Side API uses the Agenda Model Utilities API to represent dates and times. It is used by the Agenda File API to allow shared access to the agenda file by more than one client.

RAgendaServ is the client-side class, derived from RSessionBase. It is used as follows:

• Create an instance of the RAgendaServ class using RAgendaServ::NewL().

• Connect a client-server session to the server by calling RAgendaServ::Connect(). This connects to the server, starting the server first if necessary.

• Create an instance of one of the model classes (described in the Agenda File API), and set the connected server instance as the model's server pointer using the CAgnEntryModel::SetServer() function.

• Calls to the model are now routed through the server if appropriate. This means that the use of the server is normally invisible to the user of the model. However, some server functions are not available through the model and must be called directly. These functions have been documented. Undocumented server functions are not part of the API and should not be called.

• When the client has finished with the client-server session, it should end it by calling RHandleBase::Close().

Agenda File Overview

Agenda Model Utilities Overview