PQS: Post Quantum Shell 1.0.0.0a (A1)
A quantum safe shell application
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 PQS_CONNECTIONS_H
41#define PQS_CONNECTIONS_H
42
43#include "common.h"
44#include "pqs.h"
45
59
72bool pqs_connections_active(size_t index);
73
87
97size_t pqs_connections_available(void);
98
110pqs_connection_state* pqs_connections_get(uint32_t instance);
111
124void pqs_connections_initialize(size_t count, size_t maximum);
125
133void pqs_connections_clear(void);
134
142void pqs_connections_dispose(void);
143
156
166bool pqs_connections_full(void);
167
178
188void pqs_connections_reset(uint32_t instance);
189
198size_t pqs_connections_size(void);
199
220
221#endif
void pqs_connections_self_test(void)
Run the self-test for the connection collection.
Definition connections.c:245
void pqs_connections_initialize(size_t count, size_t maximum)
Initialize the connection collection.
Definition connections.c:174
size_t pqs_connections_size(void)
Get the total number of connection state items in the collection.
Definition connections.c:240
pqs_connection_state * pqs_connections_index(size_t index)
Get a connection state pointer by its collection index.
Definition connections.c:125
pqs_connection_state * pqs_connections_get(uint32_t instance)
Get a connection state pointer from a given instance number.
Definition connections.c:157
void pqs_connections_clear(void)
Erase (clear) all the connection collection members.
Definition connections.c:91
bool pqs_connections_full(void)
Check if the connection collection is full.
Definition connections.c:139
void pqs_connections_dispose(void)
Dispose of the connection collection state.
Definition connections.c:102
size_t pqs_connections_available(void)
Get the number of available (inactive) connection states in the collection.
Definition connections.c:74
pqs_connection_state * pqs_connections_next(void)
Get the next available connection state.
Definition connections.c:200
bool pqs_connections_active(size_t index)
Check if a collection member is set to active.
Definition connections.c:36
void pqs_connections_reset(uint32_t instance)
Reset a connection in the collection.
Definition connections.c:226
pqs_connection_state * pqs_connections_add(void)
Add an item to the connection collection and set it to active.
Definition connections.c:50
PQS support header.
Maintains the state for a PQS socket connection.
Definition pqs.h:790