stk_sequence_api.h

Go to the documentation of this file.

#ifndef STK_SEQUENCE_API_H
#define STK_SEQUENCE_API_H

#include "stk_sequence.h"
#include "stk_service.h"
#include "stk_env.h"

stk_sequence_t *stk_create_sequence(stk_env_t *env, char *name, stk_sequence_id id, stk_sequence_type type, stk_service_type svctype, stk_options_t *options);

stk_ret stk_destroy_sequence(stk_sequence_t *seq);

void stk_hold_sequence(stk_sequence_t *seq);

stk_sequence_id stk_acquire_sequence_id(stk_env_t *env,stk_service_type type);

stk_ret stk_release_sequence_id(stk_env_t *env,stk_sequence_id);

stk_ret stk_add_reference_to_sequence(stk_sequence_t *seq,void *data_ptr,stk_uint64 sz, stk_uint64 user_type);

stk_ret stk_add_sequence_reference_in_sequence(stk_sequence_t *seq,stk_sequence_t *merge_seq, stk_uint64 user_type);

stk_ret stk_update_ref_data_in_sequence(stk_sequence_t *seq, stk_generation_id *gen_id);

stk_ret stk_copy_to_sequence(stk_sequence_t *seq,void *data_ptr,stk_uint64 sz, stk_uint64 user_type);

stk_ret stk_copy_to_sequence_meta_data(stk_sequence_t *seq,void *data_ptr,stk_uint64 sz, stk_uint64 user_type);

stk_uint64 stk_remove_sequence_data_by_type(stk_sequence_t *seq, stk_uint64 user_type, stk_uint64 max_instances);

stk_sequence_id stk_get_sequence_id(stk_sequence_t *seq);

stk_ret stk_set_sequence_id(stk_sequence_t *seq, stk_sequence_id id);

stk_sequence_type stk_get_sequence_type(stk_sequence_t *seq);

stk_ret stk_set_sequence_type(stk_sequence_t *seq,stk_sequence_type type);

stk_ret stk_set_sequence_name(stk_sequence_t *seq,char *name);

char *stk_get_sequence_name(stk_sequence_t *seq);

stk_generation_id stk_bump_sequence_generation(stk_sequence_t *seq);

stk_generation_id stk_get_sequence_generation(stk_sequence_t *seq);

stk_env_t *stk_env_from_sequence(stk_sequence_t *seq);

int stk_number_of_sequence_elements(stk_sequence_t *seq);

int stk_has_any_sequence_elements(stk_sequence_t *seq);

stk_ret stk_alloc_in_sequence(stk_sequence_t *seq,stk_uint64 sz, stk_uint64 user_type);

void *stk_last_sequence_element(stk_sequence_t *seq);

/*
 * Following APIs are used to iterate over a sequence.
 * stk_iterate_sequence() is used when you want to apply a function as a callback to each element,
 * else a traditional set of iterator APIs allows app code to navigate a sequence.
 */

stk_ret stk_iterate_sequence(stk_sequence_t *seq,stk_sequence_cb element_cb,void *clientd);

stk_ret stk_iterate_complete_sequence(stk_sequence_t *seq,
    stk_sequence_cb before_cb, stk_sequence_cb element_cb, stk_sequence_cb after_cb, void *clientd);

stk_sequence_iterator_t *stk_sequence_iterator(stk_sequence_t *seq);

stk_ret stk_end_sequence_iterator(stk_sequence_iterator_t *seqiter);

void *stk_sequence_iterator_realloc_segment(stk_sequence_iterator_t *seqiter,stk_uint64 sz);

void *stk_sequence_iterator_ensure_segment_size(stk_sequence_iterator_t *seqiter,stk_uint64 sz);

void *stk_sequence_iterator_data(stk_sequence_iterator_t *seqiter);

void *stk_sequence_iterator_next(stk_sequence_iterator_t *seqiter);

void *stk_sequence_iterator_prev(stk_sequence_iterator_t *seqiter);

stk_ret stk_sequence_iterator_copy_data(stk_sequence_iterator_t *seqiter,void *data_ptr,stk_uint64 sz);

stk_uint64 stk_sequence_iterator_data_size(stk_sequence_iterator_t *seqiter);

stk_uint64 stk_sequence_iterator_alloc_size(stk_sequence_iterator_t *seqiter);

stk_ret stk_sequence_iterator_set_size(stk_sequence_iterator_t *seqiter,stk_uint64 sz);

stk_ret stk_sequence_iterator_set_user_type(stk_sequence_iterator_t *seqiter,stk_uint64 user_type);

stk_ret stk_sequence_find_data_by_type(stk_sequence_t *seq,stk_uint64 user_type,void **data_ptr,stk_uint64 *sz);

stk_ret stk_sequence_find_meta_data_by_type(stk_sequence_t *seq,stk_uint64 user_type,void **data_ptr,stk_uint64 *sz);
#endif