Module ffi

Help

Expand description

Exposed C APIs for arti-rpc-client-core.

See top-level documentation in header file for C conventions that affect the safety of these functions. (These include things like “all input pointers must be valid” and so on.)

Modules§

err: Error handling logic for our ffi code.

Structs§

ArtiRpcConnBuilder: A builder object used to configure and construct a connection to Arti over the RPC protocol.
ArtiRpcRawSocket: The type of a data stream socket. (This is always int on Unix-like platforms, and SOCKET on Windows.)

Constants§

ARTI_RPC_BUILDER_ENTRY_EXPANDABLE_PATH: Constant to denote a path in which Arti configuration variables are expanded.
ARTI_RPC_BUILDER_ENTRY_LITERAL_CONNECT_POINT: Constant to denote a literal connect point.
ARTI_RPC_BUILDER_ENTRY_LITERAL_PATH: Constant to denote a literal path that is not expanded.
ARTI_RPC_RESPONSE_TYPE_ERROR: A constant indicating that a message is a final error.
ARTI_RPC_RESPONSE_TYPE_RESULT: A constant indicating that a message is a final result.
ARTI_RPC_RESPONSE_TYPE_UPDATE: A constant indicating that a message is a non-final update.

Functions§

arti_rpc_conn_builder_connect^⚠: Use builder to open a new RPC connection to Arti.
arti_rpc_conn_builder_free^⚠: Release storage held by an ArtiRpcConnBuilder.
arti_rpc_conn_builder_new^⚠: Try to create a new ArtiRpcConnBuilder, with default settings.
arti_rpc_conn_builder_prepend_entry^⚠: Prepend a single entry to the connection point path in builder.
arti_rpc_conn_cancel_handle^⚠: Attempt to cancel the request on rpc_conn with the provided handle.
arti_rpc_conn_execute^⚠: Run an RPC request over rpc_conn and wait for a successful response.
arti_rpc_conn_execute_with_handle^⚠: Send an RPC request over rpc_conn, and return a handle that can wait for a successful response.
arti_rpc_conn_free^⚠: Close and free an open Arti RPC connection.
arti_rpc_conn_get_session_id^⚠: Given a pointer to an RPC connection, return the object ID for its negotiated session.
arti_rpc_conn_open_stream^⚠: Try to open an anonymized data stream over Arti.
arti_rpc_handle_free^⚠: Release storage held by an ArtiRpcHandle.
arti_rpc_handle_wait^⚠: Wait until some response arrives on an arti_rpc_handle, or until an error occurs.
arti_rpc_str_free^⚠: Free a string returned by the Arti RPC API.
arti_rpc_str_get^⚠: Return a const pointer to the underlying nul-terminated string from an ArtiRpcStr.

Type Aliases§