summaryrefslogtreecommitdiffstats
path: root/libparc/parc/logging/parc_LogEntry.h
blob: 90f6c493d128cd9493b46979bb2cc18613d523d8 (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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
/*
 * 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_LogEntry.h
 * @brief Basic Log Entry implementation
 *
 * PARCLogEntry instances contain logging information in a single message.
 *
 * Each instance contains:
 * * A log level (see PARCLogLevel).
 * * An integer version number denoting the version of the syslog protocol specification (1).
 * * A timestamp representable as an RFC 3339 Timestamp.
 * * A hostname identifing the machine that originally sent the message.
 * * An application name identifing the device or application that originated the message.
 * * A process identifier having specific meaning,
 *    except that a change in the value indicates there has been a discontinuity in a series of
 *    otherwise linear PARCLogEntry instances.
 * * A message identifier as a string without further semantics other than identifing the type of message.
 *
 */
#ifndef PARC_Library_parc_LogEntry_h
#define PARC_Library_parc_LogEntry_h

#include <stdlib.h>

#include <parc/algol/parc_Buffer.h>
#include <sys/time.h>

struct PARCLogEntry;
typedef struct PARCLogEntry PARCLogEntry;

#include <parc/logging/parc_LogLevel.h>

/**
 * Create a PARCLogEntry instance.
 *
 * @param [in] level A log level (see PARCLogLevel).
 * * An integer version number denoting the version of the syslog protocol specification (1).
 * @param [in] timeStamp The timestamp for the PARCLogEntry.
 * @param [in] hostName The hostname identifing the machine that originally sent the message.
 * @param [in] applicationName The application name identifing the device or application that originated the message.
 * @param [in] processId An identifier having no specific meaning,
 *    except that a change in the value indicates there has been a discontinuity in a series of
 *    otherwise linear PARCLogEntry instances.
 * @param [in] messageId A message identifier for the type of message.
 * @param [in] payload The message component of the LogEntry.
 *
 * @return non-NULL A valid instance of PARCLogEntry.
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 */
PARCLogEntry *parcLogEntry_Create(PARCLogLevel level,
                                  const char *hostName,
                                  const char *applicationName,
                                  const char *processId,
                                  const uint64_t messageId,
                                  const struct timeval timeStamp,
                                  PARCBuffer *payload);

/**
 * Increase the number of references to a `PARCLogEntry` instance.
 *
 * Note that new `PARCLogEntry` is not created,
 * only that the given `PARCLogEntry` reference count is incremented.
 * Discard the reference by invoking `parcLogEntry_Release`.
 *
 * @param [in] instance A pointer to a `PARCLogEntry` instance.
 *
 * @return The input `PARCLogEntry` pointer.
 *
 * Example:
 * @code
 * {
 *     PARCLogEntry *x = parcLogEntry_Create(...);
 *
 *     PARCLogEntry *x_2 = parcLogEntry_Acquire(x);
 *
 *     parcLogEntry_Release(&x);
 *     parcLogEntry_Release(&x_2);
 * }
 * @endcode
 */
PARCLogEntry *parcLogEntry_Acquire(const PARCLogEntry *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] entryPtr A pointer to a pointer to a PARCLogEntry.  The parameter is set to zero.
 *
 * Example:
 * @code
 * {
 *     PARCLogEntry *entry = parcLogEntry_Create(...)
 *
 *     parcLogEntry_Release(&entry);
 * }
 * @endcode
 */
void parcLogEntry_Release(PARCLogEntry **entryPtr);

/**
 * Produce a null-terminated string representation of the specified instance.
 *
 * The result must be freed by the caller via {@link parcMemory_Deallocate}.
 *
 * @param [in] entry A pointer to the instance.
 *
 * @return NULL Cannot allocate memory.
 * @return non-NULL A pointer to an allocated, null-terminated C string that must be deallocated via {@link parcMemory_Deallocate}.
 *
 * Example:
 * @code
 * {
 *     PARCLogEntry *entry = parcLogEntry_Create(...)
 *
 *     char *string = parcLogEntry_ToString(entry);
 *     printf("%s\n", string);
 *     parcMemory_Deallocate(&string);
 *
 *     parcLogEntry_Release(&entry);
 * }
 * @endcode
 *
 */
char *parcLogEntry_ToString(const PARCLogEntry *entry);

/**
 * Get the payload of the specified PARCLogEntry.
 *
 * @param [in] instance A pointer to a valid instance of PARCLogEntry.
 *
 * @return A pointer to the payload of the PARCLogEntry.
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 */
PARCBuffer *parcLogEntry_GetPayload(const PARCLogEntry *instance);

/**
 * Get the timestamp of the specified PARCLogEntry.
 *
 * @param [in] instance A pointer to a valid instance of PARCLogEntry.
 *
 * @return A pointer to the struct timeval of the PARCLogEntry.
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 */
const struct timeval *parcLogEntry_GetTimeStamp(const PARCLogEntry *instance);

/**
 * Get the PARCLogLevel of the given PARCLogEntry.
 *
 * @param [in] instance A pointer to a valid instance of PARCLogEntry.
 *
 * @return The PARCLogLevel of the given PARCLogEntry.
 *
 * Example:
 * @code
 * {
 *     <#example#>
 * }
 * @endcode
 */
PARCLogLevel parcLogEntry_GetLevel(const PARCLogEntry *instance);

/**
 * Get the PARCLogLevel of the given PARCLogEntry.
 *
 * @param [in] instance A pointer to a valid instance of PARCLogEntry.
 *
 * @return The version number of the given PARCLogEntry.
 *
 * Example:
 * @code
 * {
 *     <#example#>
 * }
 * @endcode
 */
int parcLogEntry_GetVersion(const PARCLogEntry *instance);

/**
 * Get the host-name of the given PARCLogEntry.
 *
 * @param [in] instance A pointer to a valid instance of PARCLogEntry.
 *
 * @return The application name of the given PARCLogEntry.
 *
 * Example:
 * @code
 * {
 *     <#example#>
 * }
 * @endcode
 */
const char *parcLogEntry_GetHostName(const PARCLogEntry *instance);

/**
 * Get the application-name of the given PARCLogEntry.
 *
 * @param [in] instance A pointer to a valid instance of PARCLogEntry.
 *
 * @return The application name of the given PARCLogEntry.
 *
 * Example:
 * @code
 * {
 *     <#example#>
 * }
 * @endcode
 */
const char *parcLogEntry_GetApplicationName(const PARCLogEntry *instance);

/**
 * Get the process-id of the given PARCLogEntry.
 *
 * @param [in] instance A pointer to a valid instance of PARCLogEntry.
 *
 * @return The process-id of the given PARCLogEntry.
 *
 * Example:
 * @code
 * {
 *     <#example#>
 * }
 * @endcode
 */
const char *parcLogEntry_GetProcessName(const PARCLogEntry *instance);

/**
 * Get the message-id of the given PARCLogEntry.
 *
 * @param [in] instance A pointer to a valid instance of PARCLogEntry.
 *
 * @return The message-id of the given PARCLogEntry.
 *
 * Example:
 * @code
 * {
 *     <#example#>
 * }
 * @endcode
 */
uint64_t parcLogEntry_GetMessageId(const PARCLogEntry *instance);

#endif