Keys Struct Reference

#include <avis/keys.h>

---

Detailed Description

A key collection used to secure notifications.

A key collection contains zero or more mappings from a KeyScheme to the Keys registered for that scheme.

See also section 7.4 of the client protocol spec.

Ownership

Once added to a Keys collection, a Key's data is considered to be owned by the key set and will be freed when elvin_keys_free() is invoked. Thus, if you wish to add the same key more than once you should elvin_key_copy() it first.

Similarly, once a Keys instance has been used in a successful call to an Elvin client connection (e.g. elvin_open_with_keys() or elvin_subscribe_with_keys()), the connection will take ownership of that key collection and free it when appropriate.

Once in use, key collections should be treated as immutable and never be modified directly.

Data Fields
ArrayList	keys [3]

---

Field Documentation

ArrayList Keys::keys[3]

---

The documentation for this struct was generated from the following file:

• avis/keys.h