blob: 2c20496b0cb949db6ac044348d524fd2844e2c85 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
/*
* Copyright (c) 2017 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file parc_Security.h
* @ingroup security
* @brief PARC Security Library framework director.
*
*/
#ifndef libparc_parc_Security_h
#define libparc_parc_Security_h
#include <stdbool.h>
/**
* Initialise the PARC Security framework.
*
* This function may be called multiple times,
* each time incrementing a reference count that is decremented by calls to `parcSecurityFini`.
*
* Example:
* @code
* {
* parcSecurity_Init();
* }
* @endcode
*
* @see parcSecurity_Fini
*/
void parcSecurity_Init(void);
/**
* Deinitialise the PARC Security framework.
*
* Example:
* @code
* {
* parcSecurity_Fini();
* }
* @endcode
*
* @see parcSecurity_Init
*/
void parcSecurity_Fini(void);
/**
* Assert that the PARC Security Framework is initalised.
*
* Example:
* @code
* {
* parcSecurity_AssertIsInitialized();
*
* }
* @endcode
*
* @see parcSecurity_Init
*/
void parcSecurity_AssertIsInitialized(void);
/**
* Determine if the PARC Security Framework is initalised.
*
* @return True if the PARC Security Framework is initalised.
* @return False otherwise
*
* Example:
* @code
* {
* parcSecurity_IsInitialized();
* }
* @endcode
*
* @see parcSecurity_Init
*/
bool parcSecurity_IsInitialized(void);
#endif // libparc_parc_Security_h
|
