📦 libqb

201 pages · page 1 of 2

D

doxygen2man(1)A tool to generate man pages from Doxygen XML files✨

Q

qb-blackbox(8)Display "flight data" from the "blackbox".✨
qb_array_create(3)Create an array with fixed sized elements.✨
qb_array_create_2(3)Create an array with fixed sized elements.✨
qb_array_elems_per_bin_get(3)Get the number of elements per bin.✨
qb_array_free(3)Free all the memory used by the array.✨
qb_array_grow(3)Grow the array.✨
qb_array_index(3)Get an element at a particular index.✨
qb_array_new_bin_cb_set(3)Get a callback when a new bin is allocated.✨
qb_array_num_bins_get(3)Get the number of bins used by the array.✨
qb_atomic_init(3)✨
qb_atomic_int_add(3)Atomically adds val to the integer pointed to by atomic.✨
qb_atomic_int_compare_and_exchange(3)Compares oldval with the integer pointed to by atomic and if they are equal, atomically exchanges *atomic with newval.✨
qb_atomic_int_exchange_and_add(3)Atomically adds val to the integer pointed to by atomic.✨
qb_atomic_int_get(3)Reads the value of the integer pointed to by atomic.✨
qb_atomic_int_set(3)Sets the value of the integer pointed to by atomic.✨
qb_atomic_pointer_compare_and_exchange(3)Compares oldval with the pointer pointed to by atomic and if they are equal, atomically exchanges *atomic with newval.✨
qb_atomic_pointer_get(3)Reads the value of the pointer pointed to by atomic.✨
qb_atomic_pointer_set(3)Sets the value of the pointer pointed to by atomic.✨
qb_hashtable_create(3)Create an unsorted map based on a hashtable.✨
qb_hdb_base_convert(3)✨
qb_hdb_create(3)Create a new database.✨
qb_hdb_destroy(3)Destroy a handle database.✨
qb_hdb_handle_create(3)Create a new handle.✨
qb_hdb_handle_destroy(3)Request the destruction of the object.✨
qb_hdb_handle_get(3)Get the instance associated with this handle and increase it's refcount.✨
qb_hdb_handle_get_always(3)Get the instance associated with this handle and increase it's refcount.✨
qb_hdb_handle_put(3)Put the instance associated with this handle and decrease it's refcount.✨
qb_hdb_handle_refcount_get(3)Get the current refcount.✨
qb_hdb_iterator_next(3)Get the next object and increament it's refcount.✨
qb_hdb_iterator_reset(3)Reset the iterator.✨
qb_hdb_nocheck_convert(3)✨
qb_ipcc_connect(3)Create a connection to an IPC service.✨
qb_ipcc_context_get(3)Get the context (set previously).✨
qb_ipcc_context_set(3)Associate a "user" pointer with this connection.✨
qb_ipcc_disconnect(3)Disconnect an IPC connection.✨
qb_ipcc_event_recv(3)Receive an event.✨
qb_ipcc_fc_enable_max_set(3)Set the maximum allowable flowcontrol value.✨
qb_ipcc_fd_get(3)Get the file descriptor to poll.✨
qb_ipcc_get_buffer_size(3)What is the actual buffer size used after the connection.✨
qb_ipcc_is_connected(3)Is the connection connected?✨
qb_ipcc_recv(3)Receive a response.✨
qb_ipcc_send(3)Send a message.✨
qb_ipcc_sendv(3)Send a message (iovec).✨
qb_ipcc_sendv_recv(3)This is a convenience function that simply sends and then recvs.✨
qb_ipcc_verify_dgram_max_msg_size(3)Test kernel dgram socket buffers to verify the largest size up to the max_msg_size value a single msg can be.✨
qb_ipcs_connection_auth_set(3)Set the permissions on and shared memory files so that both processes can read and write to them.✨
qb_ipcs_connection_first_get(3)Get the first connection.✨
qb_ipcs_connection_get_buffer_size(3)Retrieve the connection ipc buffer size.✨
qb_ipcs_connection_next_get(3)Get the next connection.✨
qb_ipcs_connection_ref(3)Increment the connection's reference counter.✨
qb_ipcs_connection_service_context_get(3)Get the context previously set on the service backing this connection.✨
qb_ipcs_connection_stats_get(3)Get the connection statistics.✨
qb_ipcs_connection_stats_get_2(3)Get (and allocate) the connection statistics.✨
qb_ipcs_connection_unref(3)Decrement the connection's reference counter.✨
qb_ipcs_context_get(3)Get the context (set previously).✨
qb_ipcs_context_set(3)Associate a "user" pointer with this connection.✨
qb_ipcs_create(3)Create a new IPC server.✨
qb_ipcs_destroy(3)Destroy the IPC server.✨
qb_ipcs_disconnect(3)Disconnect from this client.✨
qb_ipcs_enforce_buffer_size(3)Enforce the max buffer size clients must use from the server side.✨
qb_ipcs_event_send(3)Send an asynchronous event message to the client.✨
qb_ipcs_event_sendv(3)Send an asynchronous event message to the client.✨
qb_ipcs_poll_handlers_set(3)Set your poll callbacks.✨
qb_ipcs_ref(3)Increase the reference counter on the service object.✨
qb_ipcs_request_rate_limit(3)Limit the incoming request rate.✨
qb_ipcs_response_send(3)Send a response to a incoming request.✨
qb_ipcs_response_sendv(3)Send a response to a incoming request.✨
qb_ipcs_run(3)run the new IPC server.✨
qb_ipcs_service_context_get(3)Get the context (set previously).✨
qb_ipcs_service_context_set(3)Associate a "user" pointer with this service.✨
qb_ipcs_service_id_get(3)Get the service id related to this connection's service.✨
qb_ipcs_stats_get(3)Get the service statistics.✨
qb_ipcs_unref(3)Decrease the reference counter on the service object.✨
qb_list_add(3)Add this element to the list.✨
qb_list_add_tail(3)Add to the list (but at the end of the list).✨
qb_list_del(3)Delete an entry from the list.✨
qb_list_empty(3)A quick test to see if the list is empty (pointing to it's self).✨
qb_list_init(3)Initialize the list entry.✨
qb_list_is_last(3)Tests whether list is the last entry in list head.✨
qb_list_length(3)Count the number of items in the list.✨
qb_list_replace(3)Replace old entry by new one.✨
qb_list_splice(3)Join two lists.✨
qb_list_splice_tail(3)Join two lists, each list being a queue.✨
qb_log_blackbox_print_from_file(3)Read the blackbox for file and print it out.✨
qb_log_blackbox_write_to_file(3)Write the blackbox to file.✨
qb_log_callsite_get(3)Get or create a callsite at the given position.✨
qb_log_callsites_dump(3)Dump the callsite info to stdout.✨
qb_log_callsites_register(3)If you are using dynamically loadable modules via dlopen() and you load them after qb_log_init() then after you load the module you will need to do the following to get the filters to work in that…✨
qb_log_ctl(3)Main logging control function.✨
qb_log_ctl2(3)Extension of main logging control function accepting also strings.✨
qb_log_custom_close(3)Close a custom log target and release its resources.✨
qb_log_custom_open(3)Open a custom log target.✨
qb_log_facility2int(3)Convert string "auth" to equivalent number "LOG_AUTH" etc.✨
qb_log_facility2str(3)Convert number "LOG_AUTH" to equivalent string "auth" etc.✨
qb_log_file_close(3)Close a log file and release its resources.✨
qb_log_file_open(3)Open a log file.✨
qb_log_file_reopen(3)Open a new log file for an existing target.✨
qb_log_filter_ctl(3)This allows you modify the 'tags' and 'targets' callsite fields at runtime.✨
qb_log_filter_ctl2(3)This extends qb_log_filter_ctl() by been able to provide a high_priority.✨
qb_log_filter_fn_set(3)Instead of using the qb_log_filter_ctl() functions you can apply the filters manually by defining a callback and setting the targets field using qb_bit_set() and qb_bit_clear() like the following…✨
qb_log_fini(3)Logging system finalization function.✨
qb_log_format_set(3)Set the format specifiers.✨
qb_log_from_external_source(3)This function is to import logs from other code (like libraries) that provide a callback with their logs.✨
qb_log_from_external_source_va(3)✨
qb_log_init(3)Init the logging system.✨
qb_log_real_(3)Internal function: use qb_log() or qb_logt().✨
qb_log_real_va_(3)✨
qb_log_tags_stringify_fn_set(3)Set the callback to map the 'tags' bit map to a string.✨
qb_log_target_format(3)Format the callsite and timestamp info according to the format.✨
qb_log_target_user_data_get(3)Retrieve the user data set by either qb_log_custom_open or qb_log_target_user_data_set.✨
qb_log_target_user_data_set(3)Associate user data with this log target.✨
qb_log_thread_priority_set(3)When using threaded logging set the pthread policy and priority.✨
qb_log_thread_start(3)Start the logging pthread.✨
qb_loop_create(3)Create a new main loop.✨
qb_loop_destroy(3)✨
qb_loop_job_add(3)Add a job to the mainloop.✨
qb_loop_job_del(3)Delete a job from the mainloop.✨
qb_loop_poll_add(3)Add a poll job to the mainloop.✨
qb_loop_poll_del(3)Delete a poll job.✨
qb_loop_poll_low_fds_event_set(3)Set a callback to receive events on file descriptors getting low.✨
qb_loop_poll_mod(3)Modify a poll job.✨
qb_loop_run(3)Run the main loop.✨
qb_loop_signal_add(3)Add a signal job.✨
qb_loop_signal_del(3)Delete the signal job.✨
qb_loop_signal_mod(3)Modify the signal job.✨
qb_loop_stop(3)Stop the main loop.✨
qb_loop_timer_add(3)Add a timer to the mainloop.✨
qb_loop_timer_del(3)Delete a timer that is still outstanding.✨
qb_loop_timer_expire_time_get(3)Get the expiration time of the timer, as set when the timer was created.✨
qb_loop_timer_expire_time_remaining(3)Get the time remaining before the timer expires.✨
qb_loop_timer_is_running(3)Check to see if a timer that is still outstanding.✨
qb_map_count_get(3)Get the number of items in the map.✨
qb_map_destroy(3)Destroy the map, removes all the items from the map.✨
qb_map_foreach(3)Calls the given function for each of the key/value pairs in the map.✨
qb_map_get(3)Gets the value corresponding to the given key.✨
qb_map_iter_create(3)Create an iterator.✨
qb_map_iter_free(3)free the iterator✨
qb_map_iter_next(3)Get the next item.✨
qb_map_notify_add(3)Add a notifier to the map.✨
qb_map_notify_del(3)Delete a notifier from the map.✨
qb_map_notify_del_2(3)Delete a notifier from the map (including the userdata).✨
qb_map_pref_iter_create(3)Create a prefix iterator.✨
qb_map_put(3)Inserts a new key and value into a qb_map_t.✨
qb_map_rm(3)Removes a key/value pair from a map.✨
qb_rb_chmod(3)Like 'chmod', it changes the mode of the ringbuffer's resources.✨
qb_rb_chown(3)Like 'chown', it changes the owner and group of the ringbuffer's resources.✨
qb_rb_chunk_alloc(3)Allocate space for a chunk of the given size.✨
qb_rb_chunk_commit(3)Finalize the chunk.✨
qb_rb_chunk_peek(3)Read (without reclaiming) the last chunk.✨
qb_rb_chunk_read(3)Read the oldest chunk into data_out.✨
qb_rb_chunk_reclaim(3)Reclaim the oldest chunk.✨
qb_rb_chunk_write(3)Write a chunk to the ring buffer.✨
qb_rb_chunks_used(3)The total number of chunks in the buffer.✨
qb_rb_close(3)Dereference the ringbuffer and, if we are the last user, destroy it.✨
qb_rb_create_from_file(3)Load the saved ring buffer from file into temporary memory.✨
qb_rb_name_get(3)Get the name of the ringbuffer.✨
qb_rb_open(3)Create the ring buffer with the given type.✨
qb_rb_refcount_get(3)Get the reference count.✨
qb_rb_shared_user_data_get(3)Get a point to user shared data area.✨
qb_rb_space_free(3)The amount of free space in the ring buffer.✨
qb_rb_space_used(3)The total amount of data in the buffer.✨
qb_rb_write_to_file(3)Write the contents of the Ring Buffer to file.✨
qb_skiplist_create(3)Create a sorted map using a skiplist.✨
qb_strerror_r(3)strerror_r replacement.✨
qb_thread_lock(3)Calls either pthread_mutex_lock() or pthread_spin_lock().✨
qb_thread_lock_create(3)Create a new lock of the given type.✨
qb_thread_lock_destroy(3)Calls either pthread_mutex_destro() or pthread_spin_destroy().✨
qb_thread_trylock(3)Calls either pthread_mutex_trylock() or pthread_spin_trylock().✨
qb_thread_unlock(3)Calls either pthread_mutex_unlock() or pthread_spin_unlock.✨
qb_timespec_add_ms(3)Add milliseconds onto the timespec.✨
qb_trie_create(3)Create a sorted map using a Patricia trie or "Radix tree".✨
qb_trie_dump(3)print out the nodes in the trie✨
qb_util_nano_current_get(3)Get the current number of nano secounds produced by the systems incrementing clock (CLOCK_MONOTOMIC if available).✨
qb_util_nano_from_epoch_get(3)Get the time in nano seconds since epoch.✨
qb_util_nano_monotonic_hz(3)Get the frequence of the clock used in qb_util_nano_current_get().✨
qb_util_set_log_function(3)Use this function to output libqb internal log message as you wish.✨
qb_util_stopwatch_create(3)Create a Stopwatch (to time operations).✨
qb_util_stopwatch_free(3)Free the stopwatch.✨
qb_util_stopwatch_sec_elapsed_get(3)Get the elapsed time in seconds.✨
qb_util_stopwatch_split(3)Create a new time split (or lap time).✨
qb_util_stopwatch_split_ctl(3)✨
qb_util_stopwatch_split_last(3)Get the last split index to be used by qb_util_stopwatch_time_split_get().✨
qb_util_stopwatch_start(3)Start the stopwatch.✨
qb_util_stopwatch_stop(3)Stop the stopwatch.✨
qb_util_stopwatch_time_split_get(3)Read the time split (in us) from "receint" to "older".✨
qb_util_stopwatch_us_elapsed_get(3)Get the elapsed time in micro seconds.✨
qb_util_timespec_from_epoch_get(3)Get the time in timespec since epoch.✨
qbarray.h(3)This is a dynamic array (it can grow, but without moving memory).✨
qbatomic.h(3)Basic atomic integer and pointer operations.✨
qbdefs.h(3)These are some convience macros and defines.✨
qbhdb.h(3)The handle database is for reference counting objects.✨
qbipc_common.h(3)common types and definitions✨
qbipcc.h(3)Client IPC API.✨
qbipcs.h(3)Server IPC API.✨
qblist.h(3)This is a kernel style list implementation.✨
qblog.h(3)The logging API provides four main parts (basics, filtering, threading & blackbox).✨
qbloop.h(3)Main loop manages timers, jobs and polling sockets.✨
qbmap.h(3)This provides a map interface to a Patricia trie, hashtable or skiplist.✨
qbrb.h(3)This implements a ring buffer that works in "chunks", not bytes.✨