SATP: Symmetric Authenticated Tunneling Protocol 1.0.0.0a (A1)
A quantum secure symmetric pre-shared key tunneling protocol
connections.h
Go to the documentation of this file.
1/* 2025 Quantum Resistant Cryptographic Solutions Corporation
2 * All Rights Reserved.
3 *
4 * NOTICE: This software and all accompanying materials are the exclusive
5 * property of Quantum Resistant Cryptographic Solutions Corporation (QRCS).
6 * The intellectual and technical concepts contained within this implementation
7 * are proprietary to QRCS and its authorized licensors and are protected under
8 * applicable U.S. and international copyright, patent, and trade secret laws.
9 *
10 * CRYPTOGRAPHIC STANDARDS:
11 * - This software includes implementations of cryptographic algorithms such as
12 * SHA3, AES, and others. These algorithms are public domain or standardized
13 * by organizations such as NIST and are NOT the property of QRCS.
14 * - However, all source code, optimizations, and implementations in this library
15 * are original works of QRCS and are protected under this license.
16 *
17 * RESTRICTIONS:
18 * - Redistribution, modification, or unauthorized distribution of this software,
19 * in whole or in part, is strictly prohibited.
20 * - This software is provided for non-commercial, educational, and research
21 * purposes only. Commercial use in any form is expressly forbidden.
22 * - Licensing and authorized distribution are solely at the discretion of QRCS.
23 * - Any use of this software implies acceptance of these restrictions.
24 *
25 * DISCLAIMER:
26 * This software is provided "as is," without warranty of any kind, express or
27 * implied, including but not limited to warranties of merchantability or fitness
28 * for a particular purpose. QRCS disclaims all liability for any direct, indirect,
29 * incidental, or consequential damages resulting from the use or misuse of this software.
30 *
31 * FULL LICENSE:
32 * This software is subject to the **Quantum Resistant Cryptographic Solutions
33 * Proprietary License (QRCS-PL)**. The complete license terms are included
34 * in the LICENSE.txt file distributed with this software.
35 *
36 * Written by: John G. Underhill
37 * Contact: john.underhill@protonmail.com
38 */
39
40#ifndef SATP_CONNECTIONS_H
41#define SATP_CONNECTIONS_H
42
43#include "satp.h"
44
65
77bool satp_connections_active(size_t index);
78
89satp_connection_state* satp_connections_add(void);
90
100size_t satp_connections_available(void);
101
113satp_connection_state* satp_connections_get(uint32_t instance);
114
126void satp_connections_initialize(size_t count, size_t maximum);
127
135void satp_connections_clear(void);
136
144void satp_connections_dispose(void);
145
157satp_connection_state* satp_connections_index(size_t index);
158
168bool satp_connections_full(void);
169
179satp_connection_state* satp_connections_next(void);
180
190void satp_connections_reset(uint32_t instance);
191
201size_t satp_connections_size(void);
202
218void satp_connections_self_test(void);
219
220#endif
satp_connections_available
size_t satp_connections_available(void)
Get the number of available (inactive) connection states in the collection.
Definition connections.c:55
satp_connections_dispose
void satp_connections_dispose(void)
Dispose of the SATP connections collection.
Definition connections.c:83
satp_connections_self_test
void satp_connections_self_test(void)
Run the self-test routine for the connections collection.
Definition connections.c:226
satp_connections_size
size_t satp_connections_size(void)
Get the total number of connection state items in the collection.
Definition connections.c:221
satp_connections_clear
void satp_connections_clear(void)
Clear all connection states in the collection.
Definition connections.c:72
satp_connections_get
satp_connection_state * satp_connections_get(uint32_t instance)
Retrieve a connection state by its unique instance number.
Definition connections.c:138
satp_connections_reset
void satp_connections_reset(uint32_t instance)
Reset a specific connection state in the collection.
Definition connections.c:207
satp_connections_next
satp_connection_state * satp_connections_next(void)
Retrieve the next available (inactive) connection state from the collection.
Definition connections.c:181
satp_connections_add
satp_connection_state * satp_connections_add(void)
Add a new connection state to the collection and mark it as active.
Definition connections.c:31
satp_connections_index
satp_connection_state * satp_connections_index(size_t index)
Retrieve a connection state pointer by its collection index.
Definition connections.c:106
satp_connections_full
bool satp_connections_full(void)
Check if the connections collection is full.
Definition connections.c:120
satp_connections_active
bool satp_connections_active(size_t index)
Determine if a connection state at the specified index is active.
Definition connections.c:17
satp_connections_initialize
void satp_connections_initialize(size_t count, size_t maximum)
Initialize the SATP connections collection.
Definition connections.c:155
satp.h
SATP support header Common defined parameters and functions of the SATP client and server implementat...
satp_connection_state
The SATP socket connection state structure.
Definition satp.h:511