yumapro  23.10T-8
YumaPro SDK
Loading...
Searching...
No Matches
sil_sa.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
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_sil_sa
13#define _H_sil_sa
14
15/* FILE: sil_sa.h
16*********************************************************************
17* *
18* P U R P O S E *
19* *
20*********************************************************************/
21
28/*********************************************************************
29* *
30* C H A N G E H I S T O R Y *
31* *
32*********************************************************************
33
34date init comment
35----------------------------------------------------------------------
3615-mar-14 abb Begun
37*/
38
39#include <xmlstring.h>
40
41#ifndef _H_agt_not
42#include "agt_not.h"
43#endif
44
45#ifndef _H_rpc
46#include "rpc.h"
47#endif
48
49#ifndef _H_val
50#include "val.h"
51#endif
52
53#ifndef _H_sil_sa_types
54#include "sil_sa_types.h"
55#endif
56
57#ifdef __cplusplus
58extern "C" {
59#endif
60
61
62
63
88/********************************************************************
89* *
90* C O N S T A N T S *
91* *
92*********************************************************************/
93
95#define SIL_SA (const xmlChar *)"sil-sa"
96
98#define SIL_SA_MOD (const xmlChar *)"yumaworks-sil-sa"
99
101#define SIL_SA_OBJ (const xmlChar *)"sil-sa"
102
104#define SIL_REQ_OK(ST) ((ST) >= SIL_SA_ST_READY)
105
106
107/********************************************************************
108* *
109* T Y P E S *
110* *
111*********************************************************************/
112
113
114/********************************************************************
115* *
116* F U N C T I O N S *
117* *
118*********************************************************************/
119
120
128extern status_t
130
131
139extern val_value_t *
141 uint32 keynum);
142
143
151extern val_value_t *
153 uint32 keynum);
154
155
163extern void
165
166
179extern void
180 sil_sa_queue_notification_stream (const xmlChar *stream_name,
181 agt_not_msg_t *notif);
182
183
195extern void
196 sil_sa_notif_test (int8 N1,
197 int16 N2,
198 const xmlChar *N3);
199
200
201
210extern status_t
211 sil_sa_add_library_parm (const xmlChar *libstr);
212
213
222extern boolean
224
225
232extern boolean
233 sil_sa_find_library_parm (const xmlChar *libstr);
234
235
244const xmlChar*
245 sil_sa_get_username (void);
246
247
257extern const xmlChar *
259
260
270const xmlChar *
272
273
282extern void sil_sa_term_msg_test (uint32 count);
283
284
331extern status_t
332 sil_sa_add_edit (const xmlChar *defpath,
333 val_value_t *edit_value,
334 const xmlChar *edit_operation,
335 const xmlChar *insert_where,
336 const xmlChar *insert_point,
337 boolean skip_cb);
338
339
355extern val_value_t *
357 const xmlChar *defpath,
358 status_t *retres);
359
360
372extern sil_sa_child_edit_t *
374
375
388extern sil_sa_child_edit_t *
390
391
405extern void
407 op_editop_t *editop,
408 val_value_t **newval,
409 val_value_t **curval);
410
411
418extern void
420 const xmlChar *strval);
421
422
423
442extern void
443 sil_sa_get_user_data_parms (void **data_ref,
444 uint32 *data_index);
445
446
467extern void
468 sil_sa_set_user_data_parms (void *data_ref,
469 uint32 data_index);
470
471
475#ifdef __cplusplus
476} /* end extern 'C' */
477#endif
478
479#endif /* _H_sil_sa */
NETCONF Notifications DM module support.
op_editop_t
NETCONF edit-config operation types.
Definition: op.h:122
status_t
global error return code
Definition: status_enum.h:210
ncx_cfg_t
hardwire the 3 standard configs
Definition: ncxtypes.h:548
const xmlChar * sil_sa_get_client_addr(void)
Get the client address (client_addr value from the message header)
Definition: sil_sa.c:4027
void sil_sa_term_msg_test(uint32 count)
Send a <term-msg> test notification.
Definition: sil_sa.c:4076
sil_sa_child_edit_t * sil_sa_first_child_edit(rpc_msg_t *msg)
Get the first child edit from the transaction control block.
Definition: sil_sa.c:4337
void sil_sa_set_user_data_parms(void *data_ref, uint32 data_index)
Set the current GET2_USER_REF saved values.
Definition: sil_sa.c:4509
void sil_sa_queue_notification_stream(const xmlChar *stream_name, agt_not_msg_t *notif)
Send a notification-event to a specific stream, to the main server for queing by the agt_not module.
Definition: sil_sa.c:3515
void sil_sa_notif_test(int8 N1, int16 N2, const xmlChar *N3)
Send a y_get2_test_get2_notif notification.
Definition: sil_sa.c:3814
boolean sil_sa_find_library_parm(const xmlChar *libstr)
Find a library parm name in the library_parmQ.
Definition: sil_sa.c:3976
val_value_t * sil_sa_get_action_key(rpc_msg_t *msg, uint32 keynum)
Get the key value node for the specified key for ACTION ONLY.
Definition: sil_sa.c:3459
void sil_sa_set_error_msg(rpc_msg_t *msg, const xmlChar *strval)
Set Error Message string in case of error.
Definition: sil_sa.c:4441
val_value_t * sil_sa_get_data(ncx_cfg_t cfg_id, const xmlChar *defpath, status_t *retres)
Get some YANG data from the server.
Definition: sil_sa.c:4227
status_t sil_sa_add_library_parm(const xmlChar *libstr)
Add a library parameter so the SIL-SA libraries will be restricted to just these libraries instead of...
Definition: sil_sa.c:3919
const xmlChar * sil_sa_get_username(void)
Get the user_id value from the message header.
Definition: sil_sa.c:4007
status_t sil_sa_register_service(void)
Register the SIL-SA service with the YControl layer.
Definition: sil_sa.c:3347
const xmlChar * sil_sa_get_rpc_msg_id(rpc_msg_t *msg)
Get the rpc transaction id (txid_str) from the rpc_sil_sa_cb.
Definition: sil_sa.c:4052
status_t sil_sa_add_edit(const xmlChar *defpath, val_value_t *edit_value, const xmlChar *edit_operation, const xmlChar *insert_where, const xmlChar *insert_point, boolean skip_cb)
Add an edit to the current transaction from SIL-SA.
Definition: sil_sa.c:4164
sil_sa_child_edit_t * sil_sa_next_child_edit(sil_sa_child_edit_t *curedit)
Get the next child edit from the transaction control block.
Definition: sil_sa.c:4379
void sil_sa_child_edit_fields(sil_sa_child_edit_t *child_edit, op_editop_t *editop, val_value_t **newval, val_value_t **curval)
Get the child edit fields.
Definition: sil_sa.c:4412
val_value_t * sil_sa_get_key(rpc_msg_t *msg, uint32 keynum)
Get a key leaf from the sil_sa_cb backptr in the rpc_msg.
Definition: sil_sa.c:3414
boolean sil_sa_any_library_parms(void)
Check if any library parms are set.
Definition: sil_sa.c:3955
void sil_sa_get_user_data_parms(void **data_ref, uint32 *data_index)
Get the current GET2_USER_REF saved values.
Definition: sil_sa.c:4476
void sil_sa_queue_notification(agt_not_msg_t *notif)
Send a notification-event to the main server for queing by the agt_not module.
Definition: sil_sa.c:3498
NETCONF protocol remote procedure call common definitions.
Data structures for the SIL-SA subsystem.
one notification message that will be sent to all subscriptions in the stream and kept in the replay ...
Definition: agt_not.h:143
NETCONF Server and Client RPC Request/Reply Message Header.
Definition: rpc.h:181
EDIT2 children Queue Supports EDIT2 callbacks where child edits for the same parent container or list...
Definition: sil_sa_types.h:300
one value to match one type
Definition: val.h:911
Value Node Basic Support.