blob: bbec8130826900cf5843c2d93d6377a473eb1c40 (
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
90
|
/*
* 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_InMemoryVerifier.h
* @ingroup security
* @brief In memory verifier
*
*/
#ifndef libparc_parc_InMemoryVerifier_h
#define libparc_parc_InMemoryVerifier_h
#include <parc/security/parc_Verifier.h>
struct parc_inmemory_verifier;
typedef struct parc_inmemory_verifier PARCInMemoryVerifier;
extern PARCVerifierInterface *PARCInMemoryVerifierAsVerifier;
/**
* Create an empty verifier. It's destroyed via the PARCVerifierInterface->Destroy call.
*
* Example:
* @code
* <#example#>
* @endcode
*/
PARCInMemoryVerifier *parcInMemoryVerifier_Create(void);
/**
* Increase the number of references to the given `PARCInMemoryVerifier` instance.
*
* A new instance is not created,
* only that the given instance's reference count is incremented.
* Discard the acquired reference by invoking `parcInMemoryVerifier_Release()`.
*
* @param [in] signer A pointer to a `PARCInMemoryVerifier` instance.
*
* @return NULL An error occurred.
* @return non-NULL A pointer to a PARCInMemoryVerifier instance.
*
* Example:
* @code
* {
* PARCInMemoryVerifier *verifier = parcInMemoryVerifier_Create();
* PARCInMemoryVerifier *handle = parcInMemoryVerifier_Acquire(signer);
* // use the handle instance as needed
* }
* @endcode
*/
PARCInMemoryVerifier *parcInMemoryVerifier_Acquire(const PARCInMemoryVerifier *verifier);
/**
* Release a previously acquired reference to the specified instance,
* decrementing the reference count for the instance.
*
* The pointer to the instance is set to NULL as a side-effect of this function.
*
* If the invocation causes the last reference to the instance to be released,
* the instance is deallocated and the instance's implementation will perform
* additional cleanup and release other privately held references.
*
* The contents of the dealloced memory used for the PARC object are undefined.
* Do not reference the object after the last release.
*
* @param [in,out] verifierPtr A pointer to a pointer to the instance to release.
*
* Example:
* @code
* {
* PARCInMemoryVerifier *verifier = parcInMemoryVerifier_Create();
*
* parcInMemoryVerifier_Release(&verifier);
* }
* @endcode
*/
void parcInMemoryVerifier_Release(PARCInMemoryVerifier **verifierPtr);
#endif // libparc_parc_InMemoryVerifier_h
|
