blob: 19bbae5d29ad49521ca48fdcbc9b08de1da1e35c (
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
/*
* 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_LogReporterFile.h
* @brief <#Brief Description#>
*
*/
#ifndef __PARC_Library__parc_LogReporterFile__
#define __PARC_Library__parc_LogReporterFile__
#include <parc/logging/parc_LogReporter.h>
#include <parc/algol/parc_OutputStream.h>
/**
* Create a new instance of `PARCLogReporter` using the given {@link PARCOutputStream}.
*
* @param [in] output A pointer to a valid `PARCOutputStream` instance.
*
* @return NULL Memory could not be allocated.
* @return non-NULL A pointer to a valid `PARCLogReporter` instance.
*
* Example:
* @code
* {
* PARCFileOutputStream *fileOutput = parcFileOutputStream_Create(dup(STDOUT_FILENO));
* PARCOutputStream *out = parcFileOutputStream_AsOutputStream(fileOutput);
* parcFileOutputStream_Release(&fileOutput);
*
* PARCLogReporter *reporter = parcLogReporterFile_Create(out);
* parcOutputStream_Release(&out);
*
* parcLogReporter_Release(&reporter);
* }
* <#example#>
* @endcode
*/
PARCLogReporter *parcLogReporterFile_Create(PARCOutputStream *output);
/**
* Increase the number of references to a `PARCLogReporter` instance.
*
* Note that new `PARCLogReporter` is not created,
* only that the given `PARCLogReporter` reference count is incremented.
* Discard the reference by invoking `parcLogEntry_Release`.
*
* @param [in] instance A pointer to a `PARCLogReporter` instance.
*
* @return The input `PARCLogReporter` pointer.
*
* Example:
* @code
* {
* PARCLogReporter *x = parcLogReporterFile_Create(...);
*
* PARCLogReporter *x_2 = parcLogReporterFile_Acquire(x);
*
* parcLogReporterFile_Release(&x);
* parcLogReporterFile_Release(&x_2);
* }
* @endcode
*/
PARCLogReporter *parcLogReporterFile_Acquire(const PARCLogReporter *instance);
/**
* 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.
*
* @param [in,out] reporterP A pointer to a PARCLogReporter instance pointer, which will be set to zero on return.
*
* Example:
* @code
* {
* PARCLogReporter *x = parcLogReporterFile_Create(...);
*
* parcLogReporterFile_Release(&x);
* }
* @endcode
*/
void parcLogReporterFile_Release(PARCLogReporter **reporterP);
/**
* Report the given PARCLogEntry
*
* @param [in] reporter A pointer to a valid PARCLogReporter instance.
* @param [in] entry A pointer to a valid PARCLogEntry instance.
*
* Example:
* @code
* <#example#>
* @endcode
*/
void parcLogReporterFile_Report(PARCLogReporter *reporter, const PARCLogEntry *entry);
#endif /* defined(__PARC_Library__parc_LogReporterFile__) */
|
