|
| int | imquic_init (const char *secrets_log) |
| | Initialize the imquic library.
|
| |
| void | imquic_deinit (void) |
| | Uninitialize the imquic library.
|
| |
| uint32_t | imquic_get_version (void) |
| | Get the current version of the library as a number.
|
| |
| int | imquic_get_version_major (void) |
| | Get the current major version of the library as a number.
|
| |
| int | imquic_get_version_minor (void) |
| | Get the current minor version of the library as a number.
|
| |
| int | imquic_get_version_patch (void) |
| | Get the current patch version of the library as a number.
|
| |
| const char * | imquic_get_version_release (void) |
| | Get the current release type of the library as a string.
|
| |
| const char * | imquic_get_version_string (void) |
| | Get the current version of the library as a string.
|
| |
| const char * | imquic_get_version_string_full (void) |
| | Get the current version of the library, including release type, as a string.
|
| |
| const char * | imquic_get_build_time (void) |
| | Get info on when this shared object was built.
|
| |
| const char * | imquic_get_build_sha (void) |
| | Get info on the git commit was compiled in this build.
|
| |
| void | imquic_set_log_level (int level) |
| | Set the log level for the library.
|
| |
| void | imquic_set_lock_debugging (gboolean enabled) |
| | Enable or disable lock/mutex debugging.
|
| |
| void | imquic_set_refcount_debugging (gboolean enabled) |
| | Enable or disable debugging of reference counters.
|
| |
| const char * | imquic_config_str (imquic_config type) |
| | Helper function to serialize to string the name of a imquic_config property.
|
| |
| imquic_server * | imquic_create_server (const char *name,...) |
| | Method to create a new QUIC server, using variable arguments to dictate what the server should do (e.g., port to bind to, ALPN, etc.). Variable arguments are in the form of a sequence of name-value started with a IMQUIC_CONFIG_INIT and ended by a IMQUIC_CONFIG_DONE , e.g.:
|
| |
| imquic_client * | imquic_create_client (const char *name,...) |
| | Method to create a new QUIC client, using variable arguments to dictate what the client should do (e.g., address to connect to, ALPN, etc.). Variable arguments are in the form of a sequence of name-value started with a IMQUIC_CONFIG_INIT and ended by a IMQUIC_CONFIG_DONE , e.g.:
|
| |
| const char * | imquic_get_endpoint_name (imquic_endpoint *endpoint) |
| | Helper function to get the endpoint name of a local client or server.
|
| |
| gboolean | imquic_is_endpoint_server (imquic_endpoint *endpoint) |
| | Helper function to check whether a local endpoint is a server.
|
| |
| const char * | imquic_get_endpoint_alpn (imquic_endpoint *endpoint) |
| | Helper function to get the ALPN a local client or server is configured to negotiate.
|
| |
| const char * | imquic_get_endpoint_subprotocol (imquic_endpoint *endpoint) |
| | Helper function to get the WebTransport protocol a local client or server is configured to negotiate.
|
| |
| uint16_t | imquic_get_endpoint_port (imquic_endpoint *endpoint) |
| | Helper function to get the local port a client or server is bound to.
|
| |
| void | imquic_start_endpoint (imquic_endpoint *endpoint) |
| | Start a QUIC stack previously created with imquic_create_server or imquic_create_client. In case of a server, it will start listening for incoming connections; in case of a client, it will attempt to connect to the provided remote address.
|
| |
| void | imquic_shutdown_endpoint (imquic_endpoint *endpoint) |
| | Shutdown a previously started QUIC endpoint (client or server) In case of a server, it will terminate all client connections it's handling, and stop accepting new ones; in case of a client, it will terminate the active connection, if any.
|
| |
| void | imquic_set_new_connection_cb (imquic_endpoint *endpoint, void(*new_connection)(imquic_connection *conn, void *user_data)) |
| | Configure the callback function to be notified about new connections on the configured endpoint. For a server, it will be triggered any time a client successfully connects to the server; for a client, it will be triggered when the client successfully connects to the server.
|
| |
| void | imquic_set_stream_incoming_cb (imquic_endpoint *endpoint, void(*stream_incoming)(imquic_connection *conn, uint64_t stream_id, uint8_t *bytes, uint64_t offset, uint64_t length, gboolean complete)) |
| | Configure the callback function to be notified about incoming STREAM data on an existing connection handled by this endpoint.
|
| |
| void | imquic_set_datagram_incoming_cb (imquic_endpoint *endpoint, void(*datagram_incoming)(imquic_connection *conn, uint8_t *bytes, uint64_t length)) |
| | Configure the callback function to be notified about incoming DATAGRAM data on an existing connection handled by this endpoint.
|
| |
| void | imquic_set_connection_gone_cb (imquic_endpoint *endpoint, void(*connection_gone)(imquic_connection *conn)) |
| | Configure the callback function to be notified when an existing connection handled by this endpoint has been closed/shut down.
|
| |
| int | imquic_send_on_stream (imquic_connection *conn, uint64_t stream_id, uint8_t *bytes, uint64_t offset, uint64_t length, gboolean complete) |
| | Helper method to send data on a QUIC STREAM.
|
| |
| int | imquic_send_on_datagram (imquic_connection *conn, uint8_t *bytes, uint64_t length) |
| | Helper method to send data on a QUIC DATAGRAM.
|
| |
| const char * | imquic_get_connection_alpn (imquic_connection *conn) |
| | Helper function to get the ALPN of a connection.
|
| |
| const char * | imquic_get_connection_name (imquic_connection *conn) |
| | Helper function to get the display name of a connection.
|
| |
| int | imquic_new_stream_id (imquic_connection *conn, gboolean bidirectional, uint64_t *stream_id) |
| | Helper method to ask for the next usable locally originated stream ID on this connection.
|
| |
| void | imquic_close_connection (imquic_connection *conn, uint64_t error, const char *reason) |
| | Helper method to close a QUIC connection.
|
| |
| void | imquic_connection_ref (imquic_connection *conn) |
| | Increase a reference to a imquic_connection instance.
|
| |
| void | imquic_connection_unref (imquic_connection *conn) |
| | Decrease a reference to a imquic_connection instance.
|
| |
| void | imquic_stream_id_parse (uint64_t stream_id, uint64_t *id, gboolean *client_initiated, gboolean *bidirectional) |
| | Parse a QUIC stream ID to its actual ID and its other properties.
|
| |
| uint64_t | imquic_stream_id_build (uint64_t id, gboolean client_initiated, gboolean bidirectional) |
| | Build a QUIC stream ID out of its actual ID and its other properties.
|
| |
| uint64_t | imquic_varint_read (uint8_t *bytes, size_t blen, uint8_t *length) |
| | Read a variable size integer from a buffer.
|
| |
| uint8_t | imquic_varint_write (uint64_t number, uint8_t *bytes, size_t blen) |
| | Write a variable size integer to a buffer.
|
| |
| uint64_t | imquic_uint64_random (void) |
| | Helper to generate random 64 bit unsigned integers.
|
| |
| uint64_t * | imquic_uint64_dup (uint64_t num) |
| | Helper to generate an allocated copy of a uint64_t number.
|
| |
imquic public interface
- Author
- Lorenzo Miniero loren.nosp@m.zo@m.nosp@m.eetec.nosp@m.ho.c.nosp@m.om
- Copyright
- MIT License
Public interface to the imquic library. This is where public functions are callbacks to interact with the library are defined.
Method to create a new QUIC client, using variable arguments to dictate what the client should do (e.g., address to connect to, ALPN, etc.). Variable arguments are in the form of a sequence of name-value started with a IMQUIC_CONFIG_INIT and ended by a IMQUIC_CONFIG_DONE , e.g.:
imquic_client *client = imquic_create_client("echo-client",
IMQUIC_CONFIG_INIT,
IMQUIC_CONFIG_TLS_CERT, cert_pem,
IMQUIC_CONFIG_TLS_KEY, cert_key,
IMQUIC_CONFIG_TLS_PASSWORD, cert_pwd,
IMQUIC_CONFIG_REMOTE_HOST, "127.0.0.1",
IMQUIC_CONFIG_REMOTE_PORT, 9000,
IMQUIC_CONFIG_ALPN, "doq",
IMQUIC_CONFIG_DONE, NULL);
to create a QUIC client advertising the "doq" (DNS Over QUIC) ALPN. Notice that this will only create the resource, but not actually start it: before doing that, you'll need to configure the callbacks for the events you're interested in, and then use imquic_start_endpoint to start the QUIC client (which will attempt a connection).
- Note
- This creates just the QUIC (or WebTransport) stack, to negotiate the provided ALPN, but all application details are up to you. If you want imquic to handle a protocol natively for you, you'll need to use a different creator, like imquic_create_moq_server for MoQ or imquic_create_roq_server for RoQ.
- Parameters
-
| [in] | name | The endpoint name (if NULL, a default value will be set) |
- Returns
- A pointer to a imquic_server object, if successful, NULL otherwise
Method to create a new QUIC server, using variable arguments to dictate what the server should do (e.g., port to bind to, ALPN, etc.). Variable arguments are in the form of a sequence of name-value started with a IMQUIC_CONFIG_INIT and ended by a IMQUIC_CONFIG_DONE , e.g.:
imquic_server *server = imquic_create_server("echo-server",
IMQUIC_CONFIG_INIT,
IMQUIC_CONFIG_TLS_CERT, cert_pem,
IMQUIC_CONFIG_TLS_KEY, cert_key,
IMQUIC_CONFIG_TLS_PASSWORD, cert_pwd,
IMQUIC_CONFIG_LOCAL_PORT, 9000,
IMQUIC_CONFIG_ALPN, "doq",
IMQUIC_CONFIG_DONE, NULL);
to create a QUIC server advertising the "doq" (DNS Over QUIC) ALPN. Notice that this will only create the resource, but not actually start it: before doing that, you'll need to configure the callbacks for the events you're interested in, and then use imquic_start_endpoint to start the QUIC server (which will wait for incoming connections).
- Note
- This creates just the QUIC (or WebTransport) stack, to negotiate the provided ALPN, but all application details are up to you. If you want imquic to handle a protocol natively for you, you'll need to use a different creator, like imquic_create_moq_server for MoQ or imquic_create_roq_server for RoQ.
- Parameters
-
| [in] | name | The endpoint name (if NULL, a default value will be set) |
- Returns
- A pointer to a imquic_server object, if successful, NULL otherwise
