Helium
client.h
Go to the documentation of this file.
1 /* *
2  * Lightway Core
3  * Copyright (C) 2021 Express VPN International Ltd.
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  */
19 
26 #ifndef CLIENT_H
27 #define CLIENT_H
28 
29 #include <he.h>
30 
31 // Scale 1 second to wolf to 100ms
32 #define HE_WOLF_TIMEOUT_MULTIPLIER 100
33 #define HE_WOLF_RENEGOTIATION_TIMEOUT_MULTIPLIER 1000
34 
43 he_client_t *he_client_create(void);
44 
57 he_return_code_t he_client_destroy(he_client_t *client);
58 
86 he_return_code_t he_client_connect(he_client_t *client);
87 
100 he_return_code_t he_client_disconnect(he_client_t *client);
101 
116 he_return_code_t he_client_is_config_valid(he_client_t *client);
117 
118 #endif // CLIENT_H
he_return_code_t
enum he_return_code he_return_code_t
All possible return codes for helium.
he_client_connect
he_return_code_t he_client_connect(he_client_t *client)
Tries to establish a connection with a Helium server.
Definition: client.c:59
he_client_disconnect
he_return_code_t he_client_disconnect(he_client_t *client)
Try to cleanly disconnect from the remote server.
Definition: client.c:85
he_client_create
he_client_t * he_client_create(void)
Creates a Helium client.
Definition: client.c:28
he_client_is_config_valid
he_return_code_t he_client_is_config_valid(he_client_t *client)
Checks whether the client context has the basic configuration to allow Helium to connect.
Definition: client.c:98
he.h
Core internal header file for libhelium.
he_client
Data structure to hold all the state needed as a Helium client.
Definition: he.h:270
he_client_destroy
he_return_code_t he_client_destroy(he_client_t *client)
Releases all memory allocate by Helium including for the crypto layer.
Definition: client.c:46
Generated by   doxygen 1.8.11