signal_protocol_sender_key_store Struct Reference

Public Attributes
int(*	store_sender_key )(const signal_protocol_sender_key_name *sender_key_name, uint8_t *record, size_t record_len, uint8_t *user_record, size_t user_record_len, void *user_data)
int(*	load_sender_key )(signal_buffer **record, signal_buffer **user_record, const signal_protocol_sender_key_name *sender_key_name, void *user_data)
void(*	destroy_func )(void *user_data)
void *	user_data

Member Data Documentation

destroy_func

void(* signal_protocol_sender_key_store::destroy_func) (void *user_data)

Function called to perform cleanup when the data store context is being destroyed.

load_sender_key

int(* signal_protocol_sender_key_store::load_sender_key) (signal_buffer **record, signal_buffer **user_record, const signal_protocol_sender_key_name *sender_key_name, void *user_data)

Returns a copy of the sender key record corresponding to the (groupId + senderId + deviceId) tuple.

Parameters

record	pointer to a newly allocated buffer containing the record, if found. Unset if no record was found. The Signal Protocol library is responsible for freeing this buffer.
user_record	pointer to a newly allocated buffer containing application-specific data stored alongside the record. If no such data exists, then this pointer may be left unset. The Signal Protocol library is responsible for freeing this buffer.
sender_key_name	the (groupId + senderId + deviceId) tuple

Returns

1 if the record was loaded, 0 if the record was not found, negative on failure

store_sender_key

int(* signal_protocol_sender_key_store::store_sender_key) (const signal_protocol_sender_key_name *sender_key_name, uint8_t *record, size_t record_len, uint8_t *user_record, size_t user_record_len, void *user_data)

Store a serialized sender key record for a given (groupId + senderId + deviceId) tuple.

Parameters

sender_key_name	the (groupId + senderId + deviceId) tuple
record	pointer to a buffer containing the serialized record
record_len	length of the serialized record
user_record	pointer to a buffer containing application specific data to be stored alongside the serialized record. If no such data exists, then this pointer will be null.
user_record_len	length of the application specific data

Returns

0 on success, negative on failure

user_data

void* signal_protocol_sender_key_store::user_data

User data pointer

---

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

• src/signal_protocol.h