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
|
/*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 = to_pg_msg(log.str());
* ~~~~
*
*
*
* when there is ERROR then postgreSQL takes over control
* The char* messages are cleared automatically 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**, char**, char**);
/*! @brief Generates a notice on PostgreSQL
*
* This is a development helper function
* `pgr_print_notice` on code and related code must be deleted
*
* To use:
* Add at the begining of the .cpp/.hpp file:
* ~~~~{.c}
* extern "C" {
* #include "c_common/postgres_connection.h"
* #include "c_common/e_report.h"
* }
* #include "cpp_common/alloc.hpp"
* ~~~~
*
* Insert a variable where to store the message
* Save the message
* Call the function using the to_pg_msg
* ~~~~{.c}
* std::ostringstream msg;
* int this_variable = 3;
* msg << "This is the message that shows the value of : " << this_variable;
* pgr_print_notice(to_pg_msg(msg));
* ~~~~
*/
void
pgr_print_notice(const char*);
/* @brief throws postgres error when first string is not null */
void pgr_throw_error(const char*, const char*);
#endif // INCLUDE_C_COMMON_E_REPORT_H_
|
