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
|
/*PGR-GNU*****************************************************************
File: e_report.h
Function's developer:
Copyright (c) 2016 Celia Virginia Vergara Castillo
Mail: vicky_vergara@hotmail.com
------
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
********************************************************************PGR-GNU*/
#ifndef INCLUDE_C_COMMON_E_REPORT_H_
#define INCLUDE_C_COMMON_E_REPORT_H_
#pragma once
/*! @name Postgres ereport
* Send notice or error to postgreSQL (cleans the char *)
*
* From the C++ err_msg, log_msg, notice_msg are returned as a (char *),
*
* Before exiting the C code the pointers need to be freed:
* - This task can be done when there is no error,
* - Call to ERROR, gives the control back to postgreSQL
* - leaves a leak
*
* on C++ side, the message to be returned;
* ~~~~{.c}
* std::ostringstream log;
* log << "the message";
* *log_msg = pgr_msg(log.str().c_str());
* ~~~~
*
*
*
* when there is ERROR then postgreSQL takes over control
* The char* messages are cleared automaticalyy with pfree.
*
* @warning When error: Free all data not created with palloc before calling
*
*/
///@{
/*! @brief notice & error
*
* ~~~~{.c}
* pgr_notice(&log_msg, ¬ice_msg, &error_msg);
*
* precondition: before calling ereport
* assert(!*log_msg);
* assert(!*notice_msg);
* assert(!*error_msg);
* ~~~~
*/
void
pgr_global_report(
char* log_msg,
char* notice_msg,
char* error_msg);
/*! @brief notice with no hint
*
* ~~~~{.c}
* pgr_notice(&log_msg, ¬ice_msg);
*
* precondition: before calling ereport
* assert(!log_msg);
* assert(!notice_msg);
* ~~~~
*/
void
pgr_notice(
char* notice_msg);
/*! @brief notice with hint
*
* ~~~~{.c}
* pgr_notice(&log_msg, ¬ice_msg);
*
* precondition: before calling ereport
* assert(!log_msg);
* assert(!notice_msg);
* ~~~~
*/
void
pgr_notice2(
char* log_msg,
char* notice_msg);
/*! @brief error with no hint
*
*
* ~~~~{.c}
* if (err_msg) {
* pfree(<data>);
* }
* pgr_error(&error_msg);
*
* precondition: before calling ereport
* assert(!*error_msg);
* ~~~~
*/
void
pgr_error(char* error_msg);
/*! @brief error with hint
*
* ~~~~{.c}
* if (err_msg) {
* pfree(<data>);
* }
* pgr_error(&log_msg, &error_msg);
*
* precondition: before calling ereport
* assert(!*log_msg);
* assert(!*error_msg);
* ~~~~
*/
void
pgr_error2(
char* log_msg,
char* error_msg);
///@}
#endif // INCLUDE_C_COMMON_E_REPORT_H_
|
