yumapro  24.10-2
YumaPro SDK
Loading...
Searching...
No Matches
support_save.h
Go to the documentation of this file.
1#ifdef WITH_SUPPORT_SAVE
2/*
3 * Copyright (c) 2012 - 2021, YumaWorks, Inc., All Rights Reserved.
4 *
5 * Unless required by applicable law or agreed to in writing,
6 * software distributed under the License is distributed on an
7 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
8 * KIND, either express or implied. See the License for the
9 * specific language governing permissions and limitations
10 * under the License.
11 */
12#ifndef _H_support_save
13#define _H_support_save
14
15/* FILE: support_save.h
16*********************************************************************
17* *
18* P U R P O S E *
19* *
20*********************************************************************/
21
29/*********************************************************************
30* *
31* C H A N G E H I S T O R Y *
32* *
33*********************************************************************
34
35date init comment
36----------------------------------------------------------------------
3727-jul-17 abb Begun
38
39*/
40
41#include <xmlstring.h>
42
43#ifndef _H_dlq
44#include "dlq.h"
45#endif
46
47#ifndef _H_obj
48#include "obj.h"
49#endif
50
51#ifndef _H_ses
52#include "ses.h"
53#endif
54
55#ifndef _H_status_enum
56#include "status_enum.h"
57#endif
58
59#ifndef _H_xml_msg
60#include "xml_msg.h"
61#endif
62
63
64#ifdef __cplusplus
65extern "C" {
66#endif
67
68/********************************************************************
69* *
70* T Y P E S *
71* *
72*********************************************************************/
73
74
92typedef status_t
94 xml_msg_hdr_t *mhdr,
95 xmlns_id_t parent_nsid,
96 const xmlChar *subtree_name,
97 int32 indent,
98 int32 startindent);
99
100
106extern status_t
107 support_save_init (void);
108
109
115extern status_t
116 support_save_init2 (void);
117
118
123extern void
125
126
137extern status_t
138 support_save_register_cbfn (const xmlChar *subtree_name,
139 support_save_cbfn_t subtree_cbfn);
140
141
154 xml_msg_hdr_t *mhdr,
155 int32 indent,
156 int32 startindent);
157
158
164extern boolean
166
167
173extern obj_template_t *
175
176
180#ifdef __cplusplus
181} /* end extern 'C' */
182#endif
183
184#endif /* _H_support_save */
185#endif // WITH_SUPPORT_SAVE
dlq provides general double-linked list and queue support:
boolean support_save_is_active(void)
Check if a support-save is in progress.
Definition: support_save.c:458
status_t support_save_register_cbfn(const xmlChar *subtree_name, support_save_cbfn_t subtree_cbfn)
Register a support-save callback function.
Definition: support_save.c:315
void support_save_cleanup(void)
Cleanup the support_save module.
Definition: support_save.c:281
status_t support_save_init2(void)
Load the yumaworks-support-save module (phase 2)
Definition: support_save.c:246
obj_template_t * support_save_get_object(void)
Get the support-save-data object template.
Definition: support_save.c:479
status_t support_save_write(ses_cb_t *scb, xml_msg_hdr_t *mhdr, int32 indent, int32 startindent)
Write the support save information to the specified session Use the registered callbacks in the order...
Definition: support_save.c:372
status_t support_save_init(void)
Load the yumaworks-support-save module.
Definition: support_save.c:207
status_t(* support_save_cbfn_t)(ses_cb_t *scb, xml_msg_hdr_t *mhdr, xmlns_id_t parent_nsid, const xmlChar *subtree_name, int32 indent, int32 startindent)
Support Save Callback Function Used to add info to the support-save report.
Definition: support_save.h:93
status_t
global error return code
Definition: status_enum.h:210
uint16 xmlns_id_t
integer handle for registered namespaces
Definition: xmlns.h:89
Data Object Support.
NETCONF Session Common definitions module.
global error status code enumerations
One YANG data-def-stmt.
Definition: obj.h:1229
Session Control Block.
Definition: ses.h:573
Common Encoding Message Header No longer XML specific!! Used by JSON and CBOR parsing as well!...
Definition: xml_msg.h:404
XML and JSON Message send and receive support.