Classes
struct	_tf_ssb_stats_t

struct	_tf_ssb_blob_wants_t

struct	_tf_ssb_store_queue_t

Typedefs
typedef enum _tf_ssb_verify_flags_t	tf_ssb_verify_flags_t

typedef enum _tf_ssb_change_t	tf_ssb_change_t

typedef enum _tf_ssb_broadcast_origin_t	tf_ssb_broadcast_origin_t

typedef enum _tf_ssb_message_flags_t	tf_ssb_message_flags_t

typedef enum _tf_ssb_connect_flags_t	tf_ssb_connect_flags_t

typedef struct _tf_ssb_t	tf_ssb_t

typedef struct _tf_ssb_connection_t	tf_ssb_connection_t

typedef struct _tf_ssb_ebt_t	tf_ssb_ebt_t

typedef struct _tf_trace_t	tf_trace_t

typedef struct sqlite3	sqlite3

typedef struct uv_loop_s	uv_loop_t

typedef struct _tf_ssb_stats_t	tf_ssb_stats_t

typedef struct _tf_ssb_blob_wants_t	tf_ssb_blob_wants_t

typedef struct _tf_ssb_store_queue_t	tf_ssb_store_queue_t

typedef void()	tf_ssb_connect_callback_t(tf_ssb_connection_t connection, const char reason, void *user_data)

typedef void()	tf_ssb_verify_strip_store_callback_t(const char id, bool verified, bool is_new, void user_data)

typedef void()	tf_ssb_callback_cleanup_t(tf_ssb_t ssb, void user_data)

typedef void()	tf_ssb_connections_changed_callback_t(tf_ssb_t ssb, tf_ssb_change_t change, tf_ssb_connection_t connection, void *user_data)

typedef void()	tf_ssb_broadcasts_changed_callback_t(tf_ssb_t ssb, void user_data)

typedef void()	tf_ssb_message_added_callback_t(tf_ssb_t ssb, const char author, int32_t sequence, const char id, void user_data)

typedef void()	tf_ssb_blob_stored_callback_t(tf_ssb_t ssb, const char id, void *user_data)

typedef void()	tf_ssb_blob_want_added_callback_t(tf_ssb_t ssb, const char id, void *user_data)

typedef void()	tf_ssb_rpc_callback_t(tf_ssb_connection_t connection, uint8_t flags, int32_t request_number, JSValue args, const uint8_t message, size_t size, void *user_data)

typedef void()	tf_ssb_scheduled_callback_t(tf_ssb_connection_t connection, bool skip, void user_data)

Enumerations
enum	{ k_ssb_rpc_flag_binary = 0x0 , k_ssb_rpc_flag_utf8 = 0x1 , k_ssb_rpc_flag_json = 0x2 , k_ssb_rpc_mask_type = 0x3 , k_ssb_rpc_flag_end_error = 0x4 , k_ssb_rpc_flag_stream = 0x8 , k_ssb_rpc_mask_message = 0xC , k_ssb_rpc_mask_send = 0xf , k_ssb_rpc_flag_new_request = 0x10 , k_ssb_blob_bytes_max = 5 * 1024 * 1024 , k_ssb_peer_exchange_expires_seconds = 60 * 60 , k_max_private_message_recipients = 8 }

enum	_tf_ssb_verify_flags_t { k_tf_ssb_verify_flag_debug = 1 }

enum	_tf_ssb_change_t { k_tf_ssb_change_create , k_tf_ssb_change_connect , k_tf_ssb_change_remove , k_tf_ssb_change_update }

enum	_tf_ssb_broadcast_origin_t { k_tf_ssb_broadcast_origin_discovery , k_tf_ssb_broadcast_origin_room , k_tf_ssb_broadcast_origin_peer_exchange }

enum	_tf_ssb_message_flags_t { k_tf_ssb_message_flag_sequence_before_author = 1 }

enum	_tf_ssb_connect_flags_t { k_tf_ssb_connect_flag_one_shot = 0x1 , k_tf_ssb_connect_flag_do_not_store = 0x2 , k_tf_ssb_connect_flag_use_invite = 0x4 }

enum	{ k_id_base64_len = 57 , k_id_bin_len = 32 , k_blob_id_len = 53 }

Functions
tf_ssb_t *	tf_ssb_create (uv_loop_t loop, JSContext context, const char db_path, const char network_key)

void	tf_ssb_destroy (tf_ssb_t *ssb)

bool	tf_ssb_is_shutting_down (tf_ssb_t *ssb)

void	tf_ssb_start_periodic (tf_ssb_t *ssb)

void	tf_ssb_set_verbose (tf_ssb_t *ssb, bool verbose)

void	tf_ssb_set_quiet (tf_ssb_t *ssb, bool quiet)

sqlite3 *	tf_ssb_acquire_db_reader (tf_ssb_t *ssb)

sqlite3 *	tf_ssb_acquire_db_reader_restricted (tf_ssb_t *ssb)

void	tf_ssb_release_db_reader (tf_ssb_t ssb, sqlite3 db)

sqlite3 *	tf_ssb_acquire_db_writer (tf_ssb_t *ssb)

void	tf_ssb_release_db_writer (tf_ssb_t ssb, sqlite3 db)

uv_loop_t *	tf_ssb_get_loop (tf_ssb_t *ssb)

void	tf_ssb_generate_keys (tf_ssb_t *ssb)

void	tf_ssb_generate_keys_buffer (char out_public, size_t public_size, char out_private, size_t private_size)

void	tf_ssb_get_private_key (tf_ssb_t ssb, uint8_t out_private, size_t private_size)

void	tf_ssb_set_trace (tf_ssb_t ssb, tf_trace_t trace)

tf_trace_t *	tf_ssb_get_trace (tf_ssb_t *ssb)

JSContext *	tf_ssb_get_context (tf_ssb_t *ssb)

void	tf_ssb_broadcast_listener_start (tf_ssb_t *ssb, bool linger)

void	tf_ssb_broadcast_sender_start (tf_ssb_t *ssb)

void	tf_ssb_run (tf_ssb_t *ssb)

JSValue	tf_ssb_sign_message (tf_ssb_t ssb, const char author, const uint8_t private_key, JSValue message, const char previous_id, int32_t previous_sequence)

bool	tf_ssb_whoami (tf_ssb_t ssb, char out_id, size_t out_id_size)

void	tf_ssb_visit_broadcasts (tf_ssb_t ssb, void(callback)(const char host, const struct sockaddr_in addr, tf_ssb_broadcast_origin_t origin, tf_ssb_connection_t tunnel, const uint8_t pub, void user_data), void user_data)

void	tf_ssb_add_broadcast (tf_ssb_t ssb, const char connection, tf_ssb_broadcast_origin_t origin, int64_t expires_seconds)

const char **	tf_ssb_get_connection_ids (tf_ssb_t *ssb)

int	tf_ssb_get_connections (tf_ssb_t ssb, tf_ssb_connection_t *out_connections, int out_connections_count)

void	tf_ssb_connect (tf_ssb_t ssb, const char host, int port, const uint8_t key, int connect_flags, tf_ssb_connect_callback_t callback, void *user_data)

void	tf_ssb_connect_str (tf_ssb_t ssb, const char address, int connect_flags, tf_ssb_connect_callback_t callback, void user_data)

int	tf_ssb_server_open (tf_ssb_t *ssb, int port)

int	tf_ssb_server_get_port (tf_ssb_t *ssb)

void	tf_ssb_server_close (tf_ssb_t *ssb)

void	tf_ssb_close_all (tf_ssb_t ssb, const char reason)

void	tf_ssb_send_close (tf_ssb_t *ssb)

bool	tf_ssb_id_str_to_bin (uint8_t bin, const char str)

bool	tf_ssb_id_bin_to_str (char str, size_t str_size, const uint8_t bin)

bool	tf_ssb_verify_and_strip_signature (JSContext context, JSValue val, int verify_flags, char out_id, size_t out_id_size, char out_signature, size_t out_signature_size, int out_flags)

void	tf_ssb_calculate_message_id (JSContext context, JSValue message, char out_id, size_t out_id_size)

void	tf_ssb_verify_strip_and_store_message (tf_ssb_t ssb, JSValue value, tf_ssb_verify_strip_store_callback_t callback, void *user_data)

bool	tf_ssb_connection_is_client (tf_ssb_connection_t *connection)

const char *	tf_ssb_connection_get_host (tf_ssb_connection_t *connection)

int	tf_ssb_connection_get_port (tf_ssb_connection_t *connection)

tf_ssb_connection_t *	tf_ssb_connection_get_tunnel (tf_ssb_connection_t *connection)

tf_ssb_t *	tf_ssb_connection_get_ssb (tf_ssb_connection_t *connection)

JSContext *	tf_ssb_connection_get_context (tf_ssb_connection_t *connection)

void	tf_ssb_connection_close (tf_ssb_connection_t connection, const char reason)

bool	tf_ssb_connection_is_connected (tf_ssb_connection_t *connection)

bool	tf_ssb_connection_is_closing (tf_ssb_connection_t *connection)

int32_t	tf_ssb_connection_next_request_number (tf_ssb_connection_t *connection)

tf_ssb_connection_t *	tf_ssb_connection_get (tf_ssb_t ssb, const char id)

bool	tf_ssb_connection_get_id (tf_ssb_connection_t connection, char out_id, size_t out_id_size)

JSValue	tf_ssb_connection_get_object (tf_ssb_connection_t *connection)

void	tf_ssb_add_connections_changed_callback (tf_ssb_t ssb, tf_ssb_connections_changed_callback_t callback, tf_ssb_callback_cleanup_t cleanup, void user_data)

void	tf_ssb_remove_connections_changed_callback (tf_ssb_t ssb, tf_ssb_connections_changed_callback_t callback, void *user_data)

void	tf_ssb_add_broadcasts_changed_callback (tf_ssb_t ssb, tf_ssb_broadcasts_changed_callback_t callback, tf_ssb_callback_cleanup_t cleanup, void user_data)

void	tf_ssb_remove_broadcasts_changed_callback (tf_ssb_t ssb, tf_ssb_broadcasts_changed_callback_t callback, void *user_data)

void	tf_ssb_add_message_added_callback (tf_ssb_t ssb, tf_ssb_message_added_callback_t callback, tf_ssb_callback_cleanup_t cleanup, void user_data)

void	tf_ssb_remove_message_added_callback (tf_ssb_t ssb, tf_ssb_message_added_callback_t callback, void *user_data)

void	tf_ssb_notify_message_added (tf_ssb_t ssb, const char author, int32_t sequence, const char *id, JSValue message_with_keys)

void	tf_ssb_add_blob_stored_callback (tf_ssb_t ssb, tf_ssb_blob_stored_callback_t callback, tf_ssb_callback_cleanup_t cleanup, void user_data)

void	tf_ssb_remove_blob_stored_callback (tf_ssb_t ssb, tf_ssb_blob_stored_callback_t callback, void *user_data)

void	tf_ssb_notify_blob_stored (tf_ssb_t ssb, const char id)

void	tf_ssb_add_blob_want_added_callback (tf_ssb_t ssb, tf_ssb_blob_want_added_callback_t callback, tf_ssb_callback_cleanup_t cleanup, void user_data)

void	tf_ssb_remove_blob_want_added_callback (tf_ssb_t ssb, tf_ssb_blob_want_added_callback_t callback, void *user_data)

void	tf_ssb_notify_blob_want_added (tf_ssb_t ssb, const char id)

void	tf_ssb_add_rpc_callback (tf_ssb_t ssb, const char name, tf_ssb_rpc_callback_t callback, tf_ssb_callback_cleanup_t cleanup, void *user_data)

void	tf_ssb_remove_rpc_callback (tf_ssb_t ssb, const char name, tf_ssb_rpc_callback_t callback, void *user_data)

bool	tf_ssb_connection_rpc_send (tf_ssb_connection_t connection, uint8_t flags, int32_t request_number, const char new_request_name, const uint8_t message, size_t size, tf_ssb_rpc_callback_t callback, tf_ssb_callback_cleanup_t cleanup, void user_data)

bool	tf_ssb_connection_rpc_send_json (tf_ssb_connection_t connection, uint8_t flags, int32_t request_number, const char new_request_name, JSValue message, tf_ssb_rpc_callback_t callback, tf_ssb_callback_cleanup_t cleanup, void *user_data)

bool	tf_ssb_connection_rpc_send_error (tf_ssb_connection_t connection, uint8_t flags, int32_t request_number, const char error)

bool	tf_ssb_connection_rpc_send_error_method_not_allowed (tf_ssb_connection_t connection, uint8_t flags, int32_t request_number, const char name)

void	tf_ssb_connection_add_request (tf_ssb_connection_t connection, int32_t request_number, const char name, tf_ssb_rpc_callback_t callback, tf_ssb_callback_cleanup_t cleanup, void user_data, tf_ssb_connection_t dependent_connection)

void	tf_ssb_connection_remove_request (tf_ssb_connection_t *connection, int32_t request_number)

JSValue	tf_ssb_connection_requests_to_object (tf_ssb_connection_t *connection)

void	tf_ssb_connection_schedule_idle (tf_ssb_connection_t connection, const char key, tf_ssb_scheduled_callback_t callback, void user_data)

void	tf_ssb_connection_run_work (tf_ssb_connection_t connection, void(work_callback)(tf_ssb_connection_t connection, void user_data), void(after_work_callback)(tf_ssb_connection_t connection, int result, void user_data), void user_data)

void	tf_ssb_run_work (tf_ssb_t ssb, void(work_callback)(tf_ssb_t ssb, void user_data), void(after_work_callback)(tf_ssb_t ssb, int result, void user_data), void user_data)

void	tf_ssb_connection_add_new_message_request (tf_ssb_connection_t connection, const char author, int32_t request_number, bool keys)

void	tf_ssb_connection_remove_new_message_request (tf_ssb_connection_t connection, const char author)

bool	tf_ssb_connection_is_attendant (tf_ssb_connection_t *connection)

int32_t	tf_ssb_connection_get_attendant_request_number (tf_ssb_connection_t *connection)

void	tf_ssb_connection_set_attendant (tf_ssb_connection_t *connection, bool attendant, int request_number)

void	tf_ssb_connection_set_endpoint (tf_ssb_connection_t *connection, bool endpoint, int request_number)

bool	tf_ssb_connection_is_endpoint (tf_ssb_connection_t *connection)

int32_t	tf_ssb_connection_get_endpoint_request_number (tf_ssb_connection_t *connection)

void	tf_ssb_connection_clear_room_attendants (tf_ssb_connection_t *connection)

void	tf_ssb_connection_add_room_attendant (tf_ssb_connection_t connection, const char id)

void	tf_ssb_connection_remove_room_attendant (tf_ssb_connection_t connection, const char id)

tf_ssb_connection_t *	tf_ssb_connection_tunnel_create (tf_ssb_t ssb, const char portal_id, int32_t request_number, const char *target_id, int connect_flags)

int32_t	tf_ssb_connection_get_ebt_request_number (tf_ssb_connection_t *connection)

void	tf_ssb_connection_set_ebt_request_number (tf_ssb_connection_t *connection, int32_t request_number)

JSClassID	tf_ssb_get_connection_class_id ()

void	tf_ssb_get_stats (tf_ssb_t ssb, tf_ssb_stats_t out_stats)

tf_ssb_blob_wants_t *	tf_ssb_connection_get_blob_wants_state (tf_ssb_connection_t *connection)

void	tf_ssb_record_thread_busy (tf_ssb_t *ssb, bool busy)

float	tf_ssb_get_average_thread_percent (tf_ssb_t *ssb)

tf_ssb_store_queue_t *	tf_ssb_get_store_queue (tf_ssb_t *ssb)

void	tf_ssb_ref (tf_ssb_t *ssb)

void	tf_ssb_unref (tf_ssb_t *ssb)

void	tf_ssb_set_main_thread (tf_ssb_t *ssb, bool main_thread)

bool	tf_ssb_is_room (tf_ssb_t *ssb)

void	tf_ssb_set_is_room (tf_ssb_t *ssb, bool is_room)

bool	tf_ssb_is_replicator (tf_ssb_t *ssb)

void	tf_ssb_set_is_replicator (tf_ssb_t *ssb, bool is_replicator)

bool	tf_ssb_is_peer_exchange (tf_ssb_t *ssb)

void	tf_ssb_set_is_peer_exchange (tf_ssb_t *ssb, bool is_peer_exchange)

const char *	tf_ssb_get_room_name (tf_ssb_t *ssb)

void	tf_ssb_set_room_name (tf_ssb_t ssb, const char room_name)

void	tf_ssb_schedule_work (tf_ssb_t ssb, int delay_ms, void(callback)(tf_ssb_t ssb, void user_data), void *user_data)

bool	tf_ssb_hmacsha256_verify (const char public_key, const void payload, size_t payload_length, const char *signature, bool signature_is_urlb64)

void	tf_ssb_connection_adjust_read_backpressure (tf_ssb_connection_t *connection, int delta)

void	tf_ssb_connection_adjust_write_count (tf_ssb_connection_t *connection, int delta)

const char *	tf_ssb_connection_get_destroy_reason (tf_ssb_connection_t *connection)

bool	tf_ssb_tunnel_create (tf_ssb_t ssb, const char portal_id, const char *target_id, int connect_flags)

void	tf_ssb_sync_start (tf_ssb_t *ssb)

int	tf_ssb_connection_get_flags (tf_ssb_connection_t *connection)

tf_ssb_ebt_t *	tf_ssb_connection_get_ebt (tf_ssb_connection_t *connection)

char *	tf_ssb_private_message_encrypt (uint8_t private_key, const char recipients, int recipients_count, const char message, size_t message_size)

Detailed Description

Everything about SSB, SHS, and MUXRPC happens here.

Typedef Documentation

◆ sqlite3

typedef struct sqlite3 sqlite3

An SQLite database handle.

◆ tf_ssb_blob_stored_callback_t

typedef void() tf_ssb_blob_stored_callback_t(tf_ssb_t *ssb, const char *id, void *user_data)

A callback called when a blob is added to the database.

Parameters

ssb	The SSB instance.
id	The blob identifier.
user_data	The user data.

◆ tf_ssb_blob_want_added_callback_t

typedef void() tf_ssb_blob_want_added_callback_t(tf_ssb_t *ssb, const char *id, void *user_data)

A callback called when a blob is newly requested.

Parameters

ssb	The SSB instance.
id	The blob identity.
user_data	The user data.

◆ tf_ssb_blob_wants_t

typedef struct _tf_ssb_blob_wants_t tf_ssb_blob_wants_t

State about requesting blobs.

◆ tf_ssb_broadcast_origin_t

typedef enum _tf_ssb_broadcast_origin_t tf_ssb_broadcast_origin_t

The origin of a broadcast entry.

◆ tf_ssb_broadcasts_changed_callback_t

typedef void() tf_ssb_broadcasts_changed_callback_t(tf_ssb_t *ssb, void *user_data)

A callback called when a new broadcast is received or one expires.

Parameters

ssb	The SSB instance.
user_data	The user data.

◆ tf_ssb_callback_cleanup_t

typedef void() tf_ssb_callback_cleanup_t(tf_ssb_t *ssb, void *user_data)

A callback called when a callback is cleaned up.

Parameters

ssb	The SSB instance.
user_data	User data.

◆ tf_ssb_change_t

typedef enum _tf_ssb_change_t tf_ssb_change_t

The type of change to a set of connections.

◆ tf_ssb_connect_callback_t

typedef void() tf_ssb_connect_callback_t(tf_ssb_connection_t *connection, const char *reason, void *user_data)

Callback for completing establishing a connection.

Parameters

connection	The established connection if successful or null.
reason	The reason for failure if the connection failed.
user_data	User data.

◆ tf_ssb_connect_flags_t

typedef enum _tf_ssb_connect_flags_t tf_ssb_connect_flags_t

Flags affecting an SSB connection.

◆ tf_ssb_connection_t

typedef struct _tf_ssb_connection_t tf_ssb_connection_t

An SSB connection.

◆ tf_ssb_connections_changed_callback_t

typedef void() tf_ssb_connections_changed_callback_t(tf_ssb_t *ssb, tf_ssb_change_t change, tf_ssb_connection_t *connection, void *user_data)

A callback called when the connection list changes.

Parameters

ssb	The SSB instance.
change	The type of change.
connection	The connection that changed.
user_data	User data.

◆ tf_ssb_ebt_t

typedef struct _tf_ssb_ebt_t tf_ssb_ebt_t

A connection's EBT state.

◆ tf_ssb_message_added_callback_t

typedef void() tf_ssb_message_added_callback_t(tf_ssb_t *ssb, const char *author, int32_t sequence, const char *id, void *user_data)

A callback called when a message is added to the database.

Parameters

ssb	The SSB instance.
author	The author identity.
sequence	The message sequence number.
id	The message identifier.
user_data	The user data.

◆ tf_ssb_message_flags_t

typedef enum _tf_ssb_message_flags_t tf_ssb_message_flags_t

Flags describing the structure of a message.

◆ tf_ssb_rpc_callback_t

typedef void() tf_ssb_rpc_callback_t(tf_ssb_connection_t *connection, uint8_t flags, int32_t request_number, JSValue args, const uint8_t *message, size_t size, void *user_data)

A function called when a MUXRPC request is made.

Parameters

connection	The SSB connection.
flags	The RPC flags.
request_number	The request number.
args	Request arguments.
message	The raw message data.
size	The size of the raw message data.
user_data	User data registered with the callback.

◆ tf_ssb_scheduled_callback_t

typedef void() tf_ssb_scheduled_callback_t(tf_ssb_connection_t *connection, bool skip, void *user_data)

A function scheduled to be run later.

Parameters

connection	The owning connection.
skip	Whether the work ought to be skipped, because it is being replaced.
user_data	User data registered with the callback.

◆ tf_ssb_stats_t

typedef struct _tf_ssb_stats_t tf_ssb_stats_t

Statistics about an SSB instance.

◆ tf_ssb_store_queue_t

typedef struct _tf_ssb_store_queue_t tf_ssb_store_queue_t

A queue for storing messages.

◆ tf_ssb_t

typedef struct _tf_ssb_t tf_ssb_t

An SSB instance.

◆ tf_ssb_verify_flags_t

typedef enum _tf_ssb_verify_flags_t tf_ssb_verify_flags_t

Flags affecting signature verification.

◆ tf_ssb_verify_strip_store_callback_t

typedef void() tf_ssb_verify_strip_store_callback_t(const char *id, bool verified, bool is_new, void *user_data)

A function called on completion of tf_ssb_verify_strip_and_store_message().

Parameters

id	The stored message identifier.
verified	True if the message was verified successfully.
is_new	True if the message was newly added to the database.
user_data	The user data.

◆ tf_trace_t

typedef struct _tf_trace_t tf_trace_t

A trace instance.

◆ uv_loop_t

typedef struct uv_loop_s uv_loop_t

An event loop.

Enumeration Type Documentation

◆ _tf_ssb_broadcast_origin_t

enum _tf_ssb_broadcast_origin_t

The origin of a broadcast entry.

◆ _tf_ssb_change_t

enum _tf_ssb_change_t

The type of change to a set of connections.

◆ _tf_ssb_connect_flags_t

enum _tf_ssb_connect_flags_t

Flags affecting an SSB connection.

◆ _tf_ssb_message_flags_t

enum _tf_ssb_message_flags_t

Flags describing the structure of a message.

Enumerator
k_tf_ssb_message_flag_sequence_before_author	The sequence field precedes the author field if specified. The other way around, otherwise.

◆ _tf_ssb_verify_flags_t

enum _tf_ssb_verify_flags_t

Flags affecting signature verification.

Function Documentation

◆ tf_ssb_acquire_db_reader()

sqlite3 * tf_ssb_acquire_db_reader ( tf_ssb_t * ssb )

Acquire an SQLite database for unrestricted reading. Release qith tf_ssb_release_db_reader().

Parameters

ssb	The SSB instance.

Returns: A database with full read access to the database.

◆ tf_ssb_acquire_db_reader_restricted()

sqlite3 * tf_ssb_acquire_db_reader_restricted ( tf_ssb_t * ssb )

Acquire an SQLite database for restricted reading. Release qith tf_ssb_release_db_reader().

Parameters

ssb	The SSB instance.

Returns: A database with read access to a safe subset of the database.

◆ tf_ssb_acquire_db_writer()

sqlite3 * tf_ssb_acquire_db_writer ( tf_ssb_t * ssb )

Acquire an SQLite database with full write access to the database. Release with tf_ssb_release_db_writer().

Parameters

ssb	The SSB instance.

Returns: The writable database.

◆ tf_ssb_add_blob_stored_callback()

void tf_ssb_add_blob_stored_callback	(	tf_ssb_t *	ssb,
		tf_ssb_blob_stored_callback_t *	callback,
		tf_ssb_callback_cleanup_t *	cleanup,
		void *	user_data
	)

Register a callback called when a blob is added to the database.

Parameters

ssb	The SSB instance.
callback	The callback function.
cleanup	A function to call when the callback is removed.
user_data	User data to pass to the callback.

◆ tf_ssb_add_blob_want_added_callback()

void tf_ssb_add_blob_want_added_callback	(	tf_ssb_t *	ssb,
		tf_ssb_blob_want_added_callback_t *	callback,
		tf_ssb_callback_cleanup_t *	cleanup,
		void *	user_data
	)

Register a function to be called when a blob is newly requested.

Parameters

ssb	The SSB instance.
callback	The callback.
cleanup	A function to call when the callback is removed.
user_data	User data to pass to the callback.

◆ tf_ssb_add_broadcast()

void tf_ssb_add_broadcast	(	tf_ssb_t *	ssb,
		const char *	connection,
		tf_ssb_broadcast_origin_t	origin,
		int64_t	expires_seconds
	)

Add a broadcast entry.

Parameters

ssb	The SSB instance.
connection	The connection string to add.
origin	The origin of the broadcast entry.
expires_seconds	How long the broadcast entry should last.

◆ tf_ssb_add_broadcasts_changed_callback()

void tf_ssb_add_broadcasts_changed_callback	(	tf_ssb_t *	ssb,
		tf_ssb_broadcasts_changed_callback_t *	callback,
		tf_ssb_callback_cleanup_t *	cleanup,
		void *	user_data
	)

Register a callback when broadcasts change.

Parameters

ssb	The SSB instance.
callback	The callback function.
cleanup	A function to call when the callback is removed.
user_data	User data to pass to the callback.

◆ tf_ssb_add_connections_changed_callback()

void tf_ssb_add_connections_changed_callback	(	tf_ssb_t *	ssb,
		tf_ssb_connections_changed_callback_t *	callback,
		tf_ssb_callback_cleanup_t *	cleanup,
		void *	user_data
	)

Register a callback when the connection list changes.

Parameters

ssb	The SSB instance.
callback	The callback to register.
cleanup	The cleanup callback to register.
user_data	User data to pass to the callbacks.

◆ tf_ssb_add_message_added_callback()

void tf_ssb_add_message_added_callback	(	tf_ssb_t *	ssb,
		tf_ssb_message_added_callback_t *	callback,
		tf_ssb_callback_cleanup_t *	cleanup,
		void *	user_data
	)

Register a callback called when a message is added to the database.

Parameters

ssb	The SSB instance.
callback	The callback function.
cleanup	A function to call when the callback is removed.
user_data	User data to pass to the callback.

◆ tf_ssb_add_rpc_callback()

void tf_ssb_add_rpc_callback	(	tf_ssb_t *	ssb,
		const char *	name,
		tf_ssb_rpc_callback_t *	callback,
		tf_ssb_callback_cleanup_t *	cleanup,
		void *	user_data
	)

Register a MUXRPC callback by name.

Parameters

ssb	The SSB instance.
name	The RPC name as a .-separated string.
callback	The callback.
cleanup	A function to be called when the callback is removed.
user_data	User data to pass to the callback.

◆ tf_ssb_broadcast_listener_start()

void tf_ssb_broadcast_listener_start	(	tf_ssb_t *	ssb,
		bool	linger
	)

Begin listening for SSB discovery messages.

Parameters

ssb	The SSB instance.
linger	True if listening for broadcasts should keep the event loop alive.

◆ tf_ssb_broadcast_sender_start()

void tf_ssb_broadcast_sender_start ( tf_ssb_t * ssb )

Begin sending SSB discovevry messages.

Parameters

ssb	The SSB instance.

◆ tf_ssb_calculate_message_id()

void tf_ssb_calculate_message_id	(	JSContext *	context,
		JSValue	message,
		char *	out_id,
		size_t	out_id_size
	)

Determine the message identifier.

Parameters

	context	A JS context.
	message	The message.
[out]	out_id	A buffer to receive the identifier.
	out_id_size	The size of out_id.

◆ tf_ssb_close_all()

void tf_ssb_close_all	(	tf_ssb_t *	ssb,
		const char *	reason
	)

Close all active SHS connections.

Parameters

ssb	The SSB instance.
reason	Reason for the close.

◆ tf_ssb_connect()

void tf_ssb_connect	(	tf_ssb_t *	ssb,
		const char *	host,
		int	port,
		const uint8_t *	key,
		int	connect_flags,
		tf_ssb_connect_callback_t *	callback,
		void *	user_data
	)

Establish an SHS connection with a host.

Parameters

ssb	The SSB instance.
host	The host name or address.
port	The host's SHS port.
key	The host's SSB identity.
connect_flags	Flags affecting the connection.
callback	Completion callback.
user_data	User data to be passed to the callback.

◆ tf_ssb_connect_str()

void tf_ssb_connect_str	(	tf_ssb_t *	ssb,
		const char *	address,
		int	connect_flags,
		tf_ssb_connect_callback_t *	callback,
		void *	user_data
	)

Establish an SHS connection with a host by string address.

Parameters

ssb	The SSB instance.
address	The address.
connect_flags	Flags affecting the connection.
callback	Completion callback.
user_data	User data to be passed to the callback.

◆ tf_ssb_connection_add_new_message_request()

void tf_ssb_connection_add_new_message_request	(	tf_ssb_connection_t *	connection,
		const char *	author,
		int32_t	request_number,
		bool	keys
	)

Register for new messages on a connection.

Parameters

connection	The SHS connection.
author	The author for whom to request new messages.
request_number	The MUXRPC request on which to send new messages.
keys	Whether to send with keys.

◆ tf_ssb_connection_add_request()

void tf_ssb_connection_add_request	(	tf_ssb_connection_t *	connection,
		int32_t	request_number,
		const char *	name,
		tf_ssb_rpc_callback_t *	callback,
		tf_ssb_callback_cleanup_t *	cleanup,
		void *	user_data,
		tf_ssb_connection_t *	dependent_connection
	)

Register a callback to be called when a message is received for the given request number.

Parameters

connection	The connection on which to register the callback.
request_number	The request number.
name	The name of the RPC request.
callback	The callback.
cleanup	The function to call when the callback is removed.
user_data	User data to pass to the callback.
dependent_connection	A connection, which, if removed, invalidates this request.

◆ tf_ssb_connection_add_room_attendant()

void tf_ssb_connection_add_room_attendant	(	tf_ssb_connection_t *	connection,
		const char *	id
	)

Add a room attendant.

Parameters

connection	The SHS connection.
id	The attendant identifier.

◆ tf_ssb_connection_adjust_read_backpressure()

void tf_ssb_connection_adjust_read_backpressure	(	tf_ssb_connection_t *	connection,
		int	delta
	)

Adjust read backpressure. If it gets too high, TCP receive will be paused until it lowers.

Parameters

connection	The connection on which to affect backpressure.
delta	The change in backpressure. Higher will eventually pause receive. Lower will resume it.

◆ tf_ssb_connection_adjust_write_count()

void tf_ssb_connection_adjust_write_count	(	tf_ssb_connection_t *	connection,
		int	delta
	)

Adjust write count. Work scheduled by tf_ssb_connection_schedule_idle will only start when this reaches zero.

Parameters

connection	The connection on which to affect backpressure.
delta	The change in write count. Higher will pause processing scheduled idle work queue. Lower will resume it.

◆ tf_ssb_connection_clear_room_attendants()

void tf_ssb_connection_clear_room_attendants ( tf_ssb_connection_t * connection )

Clear all attendants from a room.

Parameters

connection The SHS connection.

◆ tf_ssb_connection_close()

void tf_ssb_connection_close	(	tf_ssb_connection_t *	connection,
		const char *	reason
	)

Close a connection.

Parameters

connection	The connection.
reason	Human-readable reason for closing the connection.

◆ tf_ssb_connection_get()

tf_ssb_connection_t * tf_ssb_connection_get	(	tf_ssb_t *	ssb,
		const char *	id
	)

Get an active connection by its identity.

Parameters

ssb	The SSB instance.
id	The SSB identity.

Returns: The connection if found or NULL.

◆ tf_ssb_connection_get_attendant_request_number()

int32_t tf_ssb_connection_get_attendant_request_number ( tf_ssb_connection_t * connection )

Get the request number used to notify of room attendant changes.

Parameters

connection the SHS connection.

Returns: A request number.

◆ tf_ssb_connection_get_blob_wants_state()

tf_ssb_blob_wants_t * tf_ssb_connection_get_blob_wants_state ( tf_ssb_connection_t * connection )

Get information about requested blobs.

Parameters

connection An SHS connection.

Returns: Blob wants information.

◆ tf_ssb_connection_get_context()

JSContext * tf_ssb_connection_get_context ( tf_ssb_connection_t * connection )

Get a connection's JS context.

Parameters

connection The connection.

Returns: The JS context.

◆ tf_ssb_connection_get_destroy_reason()

const char * tf_ssb_connection_get_destroy_reason ( tf_ssb_connection_t * connection )

Get the reason why a connection is going away.

Parameters

connection The connection.

Returns: The reason or NULL.

◆ tf_ssb_connection_get_ebt()

tf_ssb_ebt_t * tf_ssb_connection_get_ebt ( tf_ssb_connection_t * connection )

Get a connection's EBT state.

Parameters

connection The connection.

Returns: the EBT state for the connection.

◆ tf_ssb_connection_get_ebt_request_number()

int32_t tf_ssb_connection_get_ebt_request_number ( tf_ssb_connection_t * connection )

Get the request number on which to send EBT responses.

Parameters

connection The SHS connection.

Returns: The request number.

◆ tf_ssb_connection_get_endpoint_request_number()

int32_t tf_ssb_connection_get_endpoint_request_number ( tf_ssb_connection_t * connection )

Get the request number used to notify of tunnel endpoint changes.

Parameters

connection the SHS connection.

Returns: A request number.

◆ tf_ssb_connection_get_flags()

int tf_ssb_connection_get_flags ( tf_ssb_connection_t * connection )

Get a connection's flags.

Parameters

connection The connection.

◆ tf_ssb_connection_get_host()

const char * tf_ssb_connection_get_host ( tf_ssb_connection_t * connection )

Get the hostname of the remote end of a connection.

Parameters

connection The connection.

Returns: The hostname or address.

◆ tf_ssb_connection_get_id()

bool tf_ssb_connection_get_id	(	tf_ssb_connection_t *	connection,
		char *	out_id,
		size_t	out_id_size
	)

Get the SSB identity of a connection.

Parameters

	connection	The connection.
[out]	out_id	A buffer to be populated with the identity.
	out_id_size	The size of out_id.

Returns: True if the identity was retrieved.

◆ tf_ssb_connection_get_object()

JSValue tf_ssb_connection_get_object ( tf_ssb_connection_t * connection )

Get the JS object representing a connection.

Parameters

connection The connection.

Returns: The object.

◆ tf_ssb_connection_get_port()

int tf_ssb_connection_get_port ( tf_ssb_connection_t * connection )

Get a connection's remote port number.

Parameters

connection The connection.

Returns: The port number.

◆ tf_ssb_connection_get_ssb()

tf_ssb_t * tf_ssb_connection_get_ssb ( tf_ssb_connection_t * connection )

Get a connection's SSB instance.

Parameters

connection The connection.

Returns: The SSB instance.

◆ tf_ssb_connection_get_tunnel()

tf_ssb_connection_t * tf_ssb_connection_get_tunnel ( tf_ssb_connection_t * connection )

If a connection is a tunnel, get its parent connection.

Parameters

connection The connection.

Returns: The parent connection if the connection is tunneled or NULL.

◆ tf_ssb_connection_is_attendant()

bool tf_ssb_connection_is_attendant ( tf_ssb_connection_t * connection )

Get whether we are an attendant on a room connection.

Parameters

connection The SHS connection.

Returns: True if this is an attendant connection.

◆ tf_ssb_connection_is_client()

bool tf_ssb_connection_is_client ( tf_ssb_connection_t * connection )

Check if a connection is an outgoing connection.

Parameters

connection The connection.

Returns: True if the connection is outgoing.

◆ tf_ssb_connection_is_closing()

bool tf_ssb_connection_is_closing ( tf_ssb_connection_t * connection )

Check whether a connection is in the process of closing.

Parameters

connection The connection.

Returns: True if the connection is closing.

◆ tf_ssb_connection_is_connected()

bool tf_ssb_connection_is_connected ( tf_ssb_connection_t * connection )

Check whether a connection is connected.

Parameters

connection The connection.

Returns: True if the connection is alive.

◆ tf_ssb_connection_is_endpoint()

bool tf_ssb_connection_is_endpoint ( tf_ssb_connection_t * connection )

Get whether we are a potential tunnel endpoint.

Parameters

connection The SHS connection.

Returns: True if this is an endpoint connection.

◆ tf_ssb_connection_next_request_number()

int32_t tf_ssb_connection_next_request_number ( tf_ssb_connection_t * connection )

Get the next outgoing request number for a connection.

Parameters

connection The connection.

Returns: The next request number.

◆ tf_ssb_connection_remove_new_message_request()

void tf_ssb_connection_remove_new_message_request	(	tf_ssb_connection_t *	connection,
		const char *	author
	)

Remove a request for new messages on a connection.

Parameters

connection	the SHS connection.
author	The author for whom to no longer request new messages.

◆ tf_ssb_connection_remove_request()

void tf_ssb_connection_remove_request	(	tf_ssb_connection_t *	connection,
		int32_t	request_number
	)

Remove a callback registered to be called when a message is received for the given request number.

Parameters

connection	The connection.
request_number	The request number.

◆ tf_ssb_connection_remove_room_attendant()

void tf_ssb_connection_remove_room_attendant	(	tf_ssb_connection_t *	connection,
		const char *	id
	)

Remove a room attendant.

Parameters

connection	The SHS connection.
id	The attendanr identifier.

◆ tf_ssb_connection_requests_to_object()

JSValue tf_ssb_connection_requests_to_object ( tf_ssb_connection_t * connection )

Get a debug representation of active requests.

Parameters

connection The connection.

Returns: The active requests as a JS object.

◆ tf_ssb_connection_rpc_send()

bool tf_ssb_connection_rpc_send	(	tf_ssb_connection_t *	connection,
		uint8_t	flags,
		int32_t	request_number,
		const char *	new_request_name,
		const uint8_t *	message,
		size_t	size,
		tf_ssb_rpc_callback_t *	callback,
		tf_ssb_callback_cleanup_t *	cleanup,
		void *	user_data
	)

Send a MUXRPC message.

Parameters

connection	The connection on which to send the message.
flags	The message flags.
request_number	The request number.
new_request_name	The name of the request if it is new.
message	The message payload.
size	The size of the message.
callback	A callback to call if a response is received.
cleanup	A callback to call if the callback is removed.
user_data	User data to pass to the callback.

Returns: true If the message was queued to send, false if the connection or request were invalid.

◆ tf_ssb_connection_rpc_send_error()

bool tf_ssb_connection_rpc_send_error	(	tf_ssb_connection_t *	connection,
		uint8_t	flags,
		int32_t	request_number,
		const char *	error
	)

Send a MUXRPC error message.

Parameters

connection	The connection on which to send the message.
flags	The message flags.
request_number	The request number.
error	The error string.

Returns: true If the message was queued to send, false if the connection or request were invalid.

◆ tf_ssb_connection_rpc_send_error_method_not_allowed()

bool tf_ssb_connection_rpc_send_error_method_not_allowed	(	tf_ssb_connection_t *	connection,
		uint8_t	flags,
		int32_t	request_number,
		const char *	name
	)

Send a MUXRPC "method not allowed" error message.

Parameters

connection	The connection on which to send the message.
flags	The message flags.
request_number	The request number.
name	The name of the not-allowed method.

Returns: true If the message was queued to send, false if the connection or request were invalid.

◆ tf_ssb_connection_rpc_send_json()

bool tf_ssb_connection_rpc_send_json	(	tf_ssb_connection_t *	connection,
		uint8_t	flags,
		int32_t	request_number,
		const char *	new_request_name,
		JSValue	message,
		tf_ssb_rpc_callback_t *	callback,
		tf_ssb_callback_cleanup_t *	cleanup,
		void *	user_data
	)

Send a JSON MUXRPC message.

Parameters

connection	The connection on which to send the message.
flags	The message flags.
request_number	The request number.
new_request_name	The name of the request if it is new.
message	The JS message payload.
callback	A callback to call if a response is received.
cleanup	A callback to call if the callback is removed.
user_data	User data to pass to the callback.

Returns: true If the message was queued to send, false if the connection or request were invalid.

◆ tf_ssb_connection_run_work()

void tf_ssb_connection_run_work	(	tf_ssb_connection_t *	connection,
		void()(tf_ssb_connection_t connection, void *user_data)	work_callback,
		void()(tf_ssb_connection_t connection, int result, void *user_data)	after_work_callback,
		void *	user_data
	)

Schedule work to run on a worker thread.

Parameters

connection	The owning connection.
work_callback	The callback to run on a thread.
after_work_callback	The callback to run on the main thread when the work is complete.
user_data	User data to pass to the callback.

◆ tf_ssb_connection_schedule_idle()

void tf_ssb_connection_schedule_idle	(	tf_ssb_connection_t *	connection,
		const char *	key,
		tf_ssb_scheduled_callback_t *	callback,
		void *	user_data
	)

Schedule work to be run when the connection is next idle.

Parameters

connection	The owning connection.
key	A key identifying the work. If work by the same key already exists, the new request will be discarded.
callback	The callback to call.
user_data	User data to pass to the callback.

◆ tf_ssb_connection_set_attendant()

void tf_ssb_connection_set_attendant	(	tf_ssb_connection_t *	connection,
		bool	attendant,
		int	request_number
	)

Register for attendant change notifications on a connection.

Parameters

connection	The SHS connection.
attendant	Whether this connection will be an attendant.
request_number	The request number on which to send attendant changes.

◆ tf_ssb_connection_set_ebt_request_number()

void tf_ssb_connection_set_ebt_request_number	(	tf_ssb_connection_t *	connection,
		int32_t	request_number
	)

Set the request number on which to send EBT responses.

Parameters

connection	The SHS connection.
request_number	The request number.

◆ tf_ssb_connection_set_endpoint()

void tf_ssb_connection_set_endpoint	(	tf_ssb_connection_t *	connection,
		bool	endpoint,
		int	request_number
	)

Register for endpoint change notifications on a connection.

Parameters

connection	The SHS connection.
endpoint	Whether this connection will be an endpoint.
request_number	The request number on which to send endpoint changes.

◆ tf_ssb_connection_tunnel_create()

tf_ssb_connection_t * tf_ssb_connection_tunnel_create	(	tf_ssb_t *	ssb,
		const char *	portal_id,
		int32_t	request_number,
		const char *	target_id,
		int	connect_flags
	)

Create a tunnel.

Parameters

ssb	The SSB instance.
portal_id	The identity of the tunnel intermediary.
request_number	The tunnel request.
target_id	The identity being tunneled to.
connect_flags	Flags affecting the connection.

Returns: The new tunnel connection.

◆ tf_ssb_create()

tf_ssb_t * tf_ssb_create	(	uv_loop_t *	loop,
		JSContext *	context,
		const char *	db_path,
		const char *	network_key
	)

Create an SSB instance.

Parameters

loop	The event loop to use or NULL to create a new one.
context	The JS context to use or NULL to create a new one.
db_path	The path to the SQLite database to use.
network_key	The SSB network key to use or NULL to use the standard key.

◆ tf_ssb_destroy()

void tf_ssb_destroy ( tf_ssb_t * ssb )

Destroy an SSB instance.

Parameters

ssb	The SSB instance to destroy.

◆ tf_ssb_generate_keys()

void tf_ssb_generate_keys ( tf_ssb_t * ssb )

Generate a public/private key pair for the SSB instance.

Parameters

ssb	The SSB instance.

◆ tf_ssb_generate_keys_buffer()

void tf_ssb_generate_keys_buffer	(	char *	out_public,
		size_t	public_size,
		char *	out_private,
		size_t	private_size
	)

Generate a public/private key pair and store in buffers.

Parameters

[out]	out_public	Buffer to receive the public key.
	public_size	Size of the public key buffer.
[out]	out_private	Buffer to receive the private key.
	private_size	Size of the private key buffer.

◆ tf_ssb_get_average_thread_percent()

float tf_ssb_get_average_thread_percent ( tf_ssb_t * ssb )

Get an estimate of utilization of all running threads.

Parameters

ssb	The SSB instance.

Returns: The utilization percent.

◆ tf_ssb_get_connection_class_id()

JSClassID tf_ssb_get_connection_class_id ( )

Get the JS class ID of the SSB connection class.

Returns: The class ID

◆ tf_ssb_get_connection_ids()

const char ** tf_ssb_get_connection_ids ( tf_ssb_t * ssb )

Get the identities of all active connections.

Parameters

ssb	The SSB instance.

Returns: A NULL-terminated array of SSB identities. Free with tf_free().

◆ tf_ssb_get_connections()

int tf_ssb_get_connections	(	tf_ssb_t *	ssb,
		tf_ssb_connection_t **	out_connections,
		int	out_connections_count
	)

Retrieve a list of active connections.

Parameters

	ssb	The SSB instance.
[out]	out_connections	An array to be populated with the connections.
	out_connections_count	The size of the connections array.

Returns: The number of connections populated in out_connections.

◆ tf_ssb_get_context()

JSContext * tf_ssb_get_context ( tf_ssb_t * ssb )

Get the SSB istance's JS context.

Parameters

ssb	The SSB instance.

Returns: The JS context.

◆ tf_ssb_get_loop()

uv_loop_t * tf_ssb_get_loop ( tf_ssb_t * ssb )

Get the SSB instance's event loop.

Parameters

ssb	The SSB instance.

Returns: The loop.

◆ tf_ssb_get_private_key()

void tf_ssb_get_private_key	(	tf_ssb_t *	ssb,
		uint8_t *	out_private,
		size_t	private_size
	)

Get the private key of the SSB instance.

Parameters

	ssb	The SSB instance.
[out]	out_private	Buffer to receive the private key.
	private_size	The size of the private key buffer.

◆ tf_ssb_get_room_name()

const char * tf_ssb_get_room_name ( tf_ssb_t * ssb )

Get the name of the room hosted by the running server.

Parameters

ssb	The SSB instance.

Returns: The room name or NULL.

◆ tf_ssb_get_stats()

void tf_ssb_get_stats	(	tf_ssb_t *	ssb,
		tf_ssb_stats_t *	out_stats
	)

Get general statistics about an SSB instance.

Parameters

	ssb	The SSB instance.
[out]	out_stats	Populated with performance statistics.

◆ tf_ssb_get_store_queue()

tf_ssb_store_queue_t * tf_ssb_get_store_queue ( tf_ssb_t * ssb )

Get the queue of messages in the progress of being stored.

Parameters

ssb	The SSB instance.

Returns: The queue.

◆ tf_ssb_get_trace()

tf_trace_t * tf_ssb_get_trace ( tf_ssb_t * ssb )

Get the SSB instance's trace instance.

Parameters

ssb	The SSB instance.

Returns: The trace instance.

◆ tf_ssb_hmacsha256_verify()

bool tf_ssb_hmacsha256_verify	(	const char *	public_key,
		const void *	payload,
		size_t	payload_length,
		const char *	signature,
		bool	signature_is_urlb64
	)

Verify a signature.

Parameters

public_key	The public key for which the message was signed.
payload	The signed payload.
payload_length	The length of the signed payload in bytes.
signature	The signature.
signature_is_urlb64	True if the signature is in URL base64 format, otherwise standard base64.

Returns: true If the message was successfully verified.

◆ tf_ssb_id_bin_to_str()

bool tf_ssb_id_bin_to_str	(	char *	str,
		size_t	str_size,
		const uint8_t *	bin
	)

Convert an SSB identity from binary to string.

Parameters

[out]	str	A buffer to receive the identity string.
	str_size	The size of the string buffer.
	bin	The binary identity.

Returns: True if the conversion was successful.

◆ tf_ssb_id_str_to_bin()

bool tf_ssb_id_str_to_bin	(	uint8_t *	bin,
		const char *	str
	)

Convert an SSB identity from string to binary.

Parameters

[out]	bin	A buffer to receive the binary identity.
	str	The string identity.

Returns: True if the conversion was successful.

◆ tf_ssb_is_peer_exchange()

bool tf_ssb_is_peer_exchange ( tf_ssb_t * ssb )

Get whether the running server participates in peer exchange.

Parameters

ssb	The SSB instance.

Returns: True if the server participates in peer exchange.

◆ tf_ssb_is_replicator()

bool tf_ssb_is_replicator ( tf_ssb_t * ssb )

Get whether the running server supports replication of messages and blobs.

Parameters

ssb	The SSB instance.

Returns: True if the server is a replicator.

◆ tf_ssb_is_room()

bool tf_ssb_is_room ( tf_ssb_t * ssb )

Get whether the running server is operating a room.

Parameters

ssb	The SSB instance.

Returns: True if the server is a room.

◆ tf_ssb_is_shutting_down()

bool tf_ssb_is_shutting_down ( tf_ssb_t * ssb )

Checking if the SSB instance is in the process of shutting down.

Parameters

ssb	The SSB instance.

Returns: true If the SSB instance is shutting down.

◆ tf_ssb_notify_blob_stored()

void tf_ssb_notify_blob_stored	(	tf_ssb_t *	ssb,
		const char *	id
	)

Record that a new blob was stored.

Parameters

ssb	The SSB instance.
id	The identity of the newly stored blob.

◆ tf_ssb_notify_blob_want_added()

void tf_ssb_notify_blob_want_added	(	tf_ssb_t *	ssb,
		const char *	id
	)

Call all callbacks registered for when a blob is newly requested.

Parameters

ssb	The SSB instance.
id	The requested blob identity.

◆ tf_ssb_notify_message_added()

void tf_ssb_notify_message_added	(	tf_ssb_t *	ssb,
		const char *	author,
		int32_t	sequence,
		const char *	id,
		JSValue	message_with_keys
	)

Call all callbacks registered for when a message is added to the database.

Parameters

ssb	The SSB instance.
author	The message author's identity.
sequence	The message sequence number.
id	The message identity added.
message_with_keys	The message added in the format required if keys are requested.

◆ tf_ssb_private_message_encrypt()

char * tf_ssb_private_message_encrypt	(	uint8_t *	private_key,
		const char **	recipients,
		int	recipients_count,
		const char *	message,
		size_t	message_size
	)

Encrypt a private message to a set of recipients.

Parameters

private_key	The private key of the author.
recipients	A list of recipient identities.
recipients_count	The number of recipients in recipients.
message	The plain text to post.
message_size	The length in bytes of message.

Returns: A secret box string. Free with tf_free().

◆ tf_ssb_record_thread_busy()

void tf_ssb_record_thread_busy	(	tf_ssb_t *	ssb,
		bool	busy
	)

Record whether the calling thread is busy.

Parameters

ssb	The SSB instance.
busy	True if the calling thread is now busy.

◆ tf_ssb_ref()

void tf_ssb_ref ( tf_ssb_t * ssb )

Increment the SSB instance's ref count. Prevents it from being destroyed until it reaches zero.

Parameters

ssb	The SSB instance.

◆ tf_ssb_release_db_reader()

void tf_ssb_release_db_reader	(	tf_ssb_t *	ssb,
		sqlite3 *	db
	)

Release a database acquired with tf_ssb_acquire_db_reader() or tf_ssb_acquire_db_reader_restricted().

Parameters

ssb	The SSB instance.
db	The database.

◆ tf_ssb_release_db_writer()

void tf_ssb_release_db_writer	(	tf_ssb_t *	ssb,
		sqlite3 *	db
	)

Release a database acquired with tf_ssb_acquire_db_writer().

Parameters

ssb	The SSB instance.
db	The database.

◆ tf_ssb_remove_blob_stored_callback()

void tf_ssb_remove_blob_stored_callback	(	tf_ssb_t *	ssb,
		tf_ssb_blob_stored_callback_t *	callback,
		void *	user_data
	)

Remove a callback registered for when a blob is added to the database.

Parameters

ssb	The SSB instance.
callback	The callback function.
user_data	User data registered with the callback.

◆ tf_ssb_remove_blob_want_added_callback()

void tf_ssb_remove_blob_want_added_callback	(	tf_ssb_t *	ssb,
		tf_ssb_blob_want_added_callback_t *	callback,
		void *	user_data
	)

Remove a callback registered for when a blob is newly requested.

Parameters

ssb	The SSB instance.
callback	The callback to remove.
user_data	The user data registered with the callback.

◆ tf_ssb_remove_broadcasts_changed_callback()

void tf_ssb_remove_broadcasts_changed_callback	(	tf_ssb_t *	ssb,
		tf_ssb_broadcasts_changed_callback_t *	callback,
		void *	user_data
	)

Remove a callback registered for when broadcasts changed.

Parameters

ssb	The SSB instance.
callback	The callback function.
user_data	The user data registered with the callback.

◆ tf_ssb_remove_connections_changed_callback()

void tf_ssb_remove_connections_changed_callback	(	tf_ssb_t *	ssb,
		tf_ssb_connections_changed_callback_t *	callback,
		void *	user_data
	)

Remove a callback when the connection list changes.

Parameters

ssb	The SSB instance.
callback	The callback.
user_data	The user data registered with the callback.

◆ tf_ssb_remove_message_added_callback()

void tf_ssb_remove_message_added_callback	(	tf_ssb_t *	ssb,
		tf_ssb_message_added_callback_t *	callback,
		void *	user_data
	)

Remove a callback registered for when a message is added to the database.

Parameters

ssb	The SSB instance.
callback	The callback function.
user_data	User data registered with the callback.

◆ tf_ssb_remove_rpc_callback()

void tf_ssb_remove_rpc_callback	(	tf_ssb_t *	ssb,
		const char **	name,
		tf_ssb_rpc_callback_t *	callback,
		void *	user_data
	)

Remove a MUXRPC callback.

Parameters

ssb	The SSB instance.
name	The NULL-terminated name.
callback	The callback to remove.
user_data	The user data registered with the callback.

◆ tf_ssb_run()

void tf_ssb_run ( tf_ssb_t * ssb )

Run the SSB instance until there is no work to do or stopped.

Parameters

ssb	The SSB instance.

◆ tf_ssb_run_work()

void tf_ssb_run_work	(	tf_ssb_t *	ssb,
		void()(tf_ssb_t ssb, void *user_data)	work_callback,
		void()(tf_ssb_t ssb, int result, void *user_data)	after_work_callback,
		void *	user_data
	)

Schedule work to run on a worker thread.

Parameters

ssb	The owning SSB instance.
work_callback	The callback to run on a thread.
after_work_callback	The callback to run on the main thread when the work is complete.
user_data	User data to pass to the callback.

◆ tf_ssb_schedule_work()

void tf_ssb_schedule_work	(	tf_ssb_t *	ssb,
		int	delay_ms,
		void()(tf_ssb_t ssb, void *user_data)	callback,
		void *	user_data
	)

Schedule work to be run after a time delay.

Parameters

ssb	The SSB instance.
delay_ms	The duration to wait in milliseconds.
callback	The callback to call to run the work.
user_data	User data to pass to the callback.

◆ tf_ssb_send_close()

void tf_ssb_send_close ( tf_ssb_t * ssb )

Send a graceful close message to all active SHS connections.

Parameters

ssb	The SSB instance.

◆ tf_ssb_server_close()

void tf_ssb_server_close ( tf_ssb_t * ssb )

Stop listening for SHS connections.

Parameters

ssb	The SSB instance.

◆ tf_ssb_server_get_port()

int tf_ssb_server_get_port ( tf_ssb_t * ssb )

Determine the port that a server is listening on.

Parameters

ssb	The SSB instance.

Returns: The port number, or 0 if not bound.

◆ tf_ssb_server_open()

int tf_ssb_server_open	(	tf_ssb_t *	ssb,
		int	port
	)

Begin listening for SHS connections on the given port.

Parameters

ssb	The SSB instance.
port	The port number.

Returns: The assigned port on success or 0 on failure.

◆ tf_ssb_set_is_peer_exchange()

void tf_ssb_set_is_peer_exchange	(	tf_ssb_t *	ssb,
		bool	is_peer_exchange
	)

Set whether the running server participates in peer exchange.

Parameters

ssb	The SSB instance.
is_peer_exchange	Whether to participate in peer exchange.

◆ tf_ssb_set_is_replicator()

void tf_ssb_set_is_replicator	(	tf_ssb_t *	ssb,
		bool	is_replicator
	)

Set whether the running server supports replication of messages and blobs.

Parameters

ssb	The SSB instance.
is_replicator	Whether to support replication.

◆ tf_ssb_set_is_room()

void tf_ssb_set_is_room	(	tf_ssb_t *	ssb,
		bool	is_room
	)

Set whether the running server is operating a room.

Parameters

ssb	The SSB instance.
is_room	Whether to run a room.

◆ tf_ssb_set_main_thread()

void tf_ssb_set_main_thread	(	tf_ssb_t *	ssb,
		bool	main_thread
	)

Record whether the calling thread is the main thread or not. Some operations are disallowed on the main thread for performance.

Parameters

ssb	The SSB instance.
main_thread	Whether the calling thread is the main thread.

◆ tf_ssb_set_quiet()

void tf_ssb_set_quiet	(	tf_ssb_t *	ssb,
		bool	quiet
	)

Reduce logging verbosity.

Parameters

ssb	The SSB instance.
quiet	Disable unnecessary messages.

◆ tf_ssb_set_room_name()

void tf_ssb_set_room_name	(	tf_ssb_t *	ssb,
		const char *	room_name
	)

Set the name of the room hosted by the running server.

Parameters

ssb	The SSB instance.
room_name	The name of the room.

◆ tf_ssb_set_trace()

void tf_ssb_set_trace	(	tf_ssb_t *	ssb,
		tf_trace_t *	trace
	)

Set the trace instance to use for the SSB instance.

Parameters

ssb	The SSB instance.
trace	The trace instance to use.

◆ tf_ssb_set_verbose()

void tf_ssb_set_verbose	(	tf_ssb_t *	ssb,
		bool	verbose
	)

Control logging verbosity.

Parameters

ssb	The SSB instance.
verbose	True to log messages for every RPC message sent and received.

◆ tf_ssb_sign_message()

JSValue tf_ssb_sign_message	(	tf_ssb_t *	ssb,
		const char *	author,
		const uint8_t *	private_key,
		JSValue	message,
		const char *	previous_id,
		int32_t	previous_sequence
	)

Sign an SSB message.

Parameters

ssb	The SSB instance.
author	The author's public key.
private_key	The author's private key.
message	The message to sign.
previous_id	The ID of the previous message in the feed. Optional.
previous_sequence	The sequence number of the previous message in the feed. Optional.

Returns: The signed message.

◆ tf_ssb_start_periodic()

void tf_ssb_start_periodic ( tf_ssb_t * ssb )

Start optional periodic work.

Parameters

ssb	The SSB instance.

◆ tf_ssb_sync_start()

void tf_ssb_sync_start ( tf_ssb_t * ssb )

Initiate a one time sync operation.

Parameters

ssb	The SSB instance.

◆ tf_ssb_tunnel_create()

bool tf_ssb_tunnel_create	(	tf_ssb_t *	ssb,
		const char *	portal_id,
		const char *	target_id,
		int	connect_flags
	)

Initiate a tunnel connection.

Parameters

ssb	The SSB instance.
portal_id	The public key of the instance through which to tunnel.
target_id	The public key of the instance with which to establish a connection.
connect_flags	Flags affecting the connection.

Returns: true if the tunnel instance was found.

◆ tf_ssb_unref()

void tf_ssb_unref ( tf_ssb_t * ssb )

Decrement the SSB instance's ref count. May destroy the instance when the count returns to zero.

Parameters

ssb	The SSB instance.

◆ tf_ssb_verify_and_strip_signature()

bool tf_ssb_verify_and_strip_signature	(	JSContext *	context,
		JSValue	val,
		int	verify_flags,
		char *	out_id,
		size_t	out_id_size,
		char *	out_signature,
		size_t	out_signature_size,
		int *	out_flags
	)

Verify a message's signature and remove the signature if successful.

Parameters

	context	A JS context.
	val	The message.
	verify_flags	Verification options of type tf_ssb_verify_flags_t.
[out]	out_id	A buffer to receive the message's identity.
	out_id_size	The size of out_id.
[out]	out_signature	A buffer to receive the message's signature.
	out_signature_size	The size of out_signature.
[out]	out_flags	tf_ssb_message_flags_t describing the message.

Returns: True if the signature is valid and was successfully extracted.

◆ tf_ssb_verify_strip_and_store_message()

void tf_ssb_verify_strip_and_store_message	(	tf_ssb_t *	ssb,
		JSValue	value,
		tf_ssb_verify_strip_store_callback_t *	callback,
		void *	user_data
	)

Verify a message's signature, remove the signature, and store the message in the database.

Parameters

ssb	The SSB instance.
value	The message.
callback	A callback called when the operation completed.
user_data	User data to pass to the callback.

◆ tf_ssb_visit_broadcasts()

void tf_ssb_visit_broadcasts	(	tf_ssb_t *	ssb,
		void()(const char host, const struct sockaddr_in addr, tf_ssb_broadcast_origin_t origin, tf_ssb_connection_t tunnel, const uint8_t pub, void user_data)	callback,
		void *	user_data
	)

Call a callback for each active host discovered by network discovery broadcast.

Parameters

ssb	The SSB instance.
callback	The callback.
user_data	User data for the callback.

◆ tf_ssb_whoami()

bool tf_ssb_whoami	(	tf_ssb_t *	ssb,
		char *	out_id,
		size_t	out_id_size
	)

Get the server's identity.

Parameters

	ssb	The SSB instance.
[out]	out_id	A buffer populated with the identity.
	out_id_size	The size of the identity buffer.

Returns: True if the identity was successfully retrieved.

Classes

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ sqlite3

◆ tf_ssb_blob_stored_callback_t

◆ tf_ssb_blob_want_added_callback_t

◆ tf_ssb_blob_wants_t

◆ tf_ssb_broadcast_origin_t

◆ tf_ssb_broadcasts_changed_callback_t

◆ tf_ssb_callback_cleanup_t

◆ tf_ssb_change_t

◆ tf_ssb_connect_callback_t

◆ tf_ssb_connect_flags_t

◆ tf_ssb_connection_t

◆ tf_ssb_connections_changed_callback_t

◆ tf_ssb_ebt_t

◆ tf_ssb_message_added_callback_t

◆ tf_ssb_message_flags_t

◆ tf_ssb_rpc_callback_t

◆ tf_ssb_scheduled_callback_t

◆ tf_ssb_stats_t

◆ tf_ssb_store_queue_t

◆ tf_ssb_t

◆ tf_ssb_verify_flags_t

◆ tf_ssb_verify_strip_store_callback_t

◆ tf_trace_t

◆ uv_loop_t

Enumeration Type Documentation

◆ _tf_ssb_broadcast_origin_t

◆ _tf_ssb_change_t

◆ _tf_ssb_connect_flags_t

◆ _tf_ssb_message_flags_t

◆ _tf_ssb_verify_flags_t

Function Documentation

◆ tf_ssb_acquire_db_reader()

◆ tf_ssb_acquire_db_reader_restricted()

◆ tf_ssb_acquire_db_writer()

◆ tf_ssb_add_blob_stored_callback()

◆ tf_ssb_add_blob_want_added_callback()

◆ tf_ssb_add_broadcast()

◆ tf_ssb_add_broadcasts_changed_callback()

◆ tf_ssb_add_connections_changed_callback()

◆ tf_ssb_add_message_added_callback()

◆ tf_ssb_add_rpc_callback()

◆ tf_ssb_broadcast_listener_start()

◆ tf_ssb_broadcast_sender_start()

◆ tf_ssb_calculate_message_id()

◆ tf_ssb_close_all()

◆ tf_ssb_connect()

◆ tf_ssb_connect_str()

◆ tf_ssb_connection_add_new_message_request()

◆ tf_ssb_connection_add_request()

◆ tf_ssb_connection_add_room_attendant()

◆ tf_ssb_connection_adjust_read_backpressure()

◆ tf_ssb_connection_adjust_write_count()

◆ tf_ssb_connection_clear_room_attendants()

◆ tf_ssb_connection_close()

◆ tf_ssb_connection_get()

◆ tf_ssb_connection_get_attendant_request_number()

◆ tf_ssb_connection_get_blob_wants_state()

◆ tf_ssb_connection_get_context()

◆ tf_ssb_connection_get_destroy_reason()

◆ tf_ssb_connection_get_ebt()

◆ tf_ssb_connection_get_ebt_request_number()

◆ tf_ssb_connection_get_endpoint_request_number()

◆ tf_ssb_connection_get_flags()

◆ tf_ssb_connection_get_host()

◆ tf_ssb_connection_get_id()

◆ tf_ssb_connection_get_object()

◆ tf_ssb_connection_get_port()

◆ tf_ssb_connection_get_ssb()

◆ tf_ssb_connection_get_tunnel()

◆ tf_ssb_connection_is_attendant()

◆ tf_ssb_connection_is_client()

◆ tf_ssb_connection_is_closing()

◆ tf_ssb_connection_is_connected()

◆ tf_ssb_connection_is_endpoint()