subsystem.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
 * Copyright (c) 2012 - 2021, YumaWorks, Inc., All Rights Reserved.
 *
 * 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.
 */
#ifndef _H_subsystem
#define _H_subsystem
 
/*  FILE: subsystem.h
*********************************************************************
*                                   *
*            P U R P O S E                  *
*                                   *
*********************************************************************/
 
/*********************************************************************
*                                   *
*          C H A N G E   H I S T O R Y              *
*                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
06-oct-12    abb      Begun; split from netconf_subsystem.c
 
*/
 
#ifndef _H_status_enum
#include "status_enum.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* group header only */
 
/********************************************************************
*                                                                   *
*                       C O N S T A N T S                           *
*                                                                   *
*********************************************************************/
 
#define SUBSYS_BUFFLEN  32000
 
#define SUBSYS_TRACE1(cb, fmt, ...) if (cb->traceLevel && cb->errfile) \
                                { \
                                    fprintf(cb->errfile, fmt, ##__VA_ARGS__); \
                                    fflush(cb->errfile); \
                                }
 
#define SUBSYS_TRACE2(cb, fmt, ...) if (cb->traceLevel > 1 && cb->errfile) \
                                { \
                                    fprintf(cb->errfile, fmt, ##__VA_ARGS__); \
                                    fflush(cb->errfile); \
                                }
 
#define SUBSYS_TRACE3(cb, fmt, ...) if (cb->traceLevel > 2 && cb->errfile) \
                                { \
                                    fprintf(cb->errfile, fmt, ##__VA_ARGS__); \
                                    fflush(cb->errfile); \
                                }
 
#define XML_START_MSG ((const xmlChar *)\
               "<?xml version=\"1.0\" encoding=\"UTF-8\"?>")
 
 
/********************************************************************
*                                   *
*                T Y P E S                  *
*                                   *
*********************************************************************/
 
typedef enum proto_id_t_ {
    PROTO_ID_NONE,
 
    PROTO_ID_NETCONF,
 
    PROTO_ID_YANGAPI,
 
    /* ypshell */
    PROTO_ID_CLI,
 
    PROTO_ID_WEBUI,
 
    PROTO_ID_YCONTROL,
 
    PROTO_ID_RESTCONF
} proto_id_t;
 
 
typedef status_t
    (*subsys_stdout_fn_t)(const char *buff,
                          size_t bufflen);
 
 
typedef ssize_t
    (*subsys_stdin_fn_t)(char *buff,
                         size_t bufflen);
 
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
 
extern int run_subsystem (proto_id_t protocol_id,
                          int trace_level,
                          int argc,
                          char **argv);
 
 
extern int
    run_subsystem_ex (proto_id_t protocol_id,
                      int trace_level,
                      int argc,
                      char **argv,
                      char **envp,
                      subsys_stdin_fn_t stdin_fn,
                      subsys_stdout_fn_t stdout_fn,
                      int32 stdin_len);
 
 
 
extern int
    run_subsystem_full (proto_id_t protocol_id,
                        int trace_level,
                        int argc,
                        char **argv,
                        char **envp,
                        subsys_stdin_fn_t stdin_fn,
                        subsys_stdout_fn_t stdout_fn,
                        int32 stdin_len);
 
 
extern status_t
    init_subsystem_ycontrol (int trace_level,
                             const char *subsys_id);
 
 
extern status_t
    init_subsystem_ycontrol_ha (int trace_level,
                                const char *subsys_id,
                                const char *server_id,
                                const char *server_addr,
                                uint16 server_port);
 
 
extern status_t
    connect_subsystem_ycontrol (int *retfd);
 
extern status_t
    connect_subsystem_srid (const char *server_root,
                            int *retfd);
 
 
extern status_t
    check_subsystem_io (void);
 
 
extern void
    cleanup_subsystem_ycontrol (status_t res);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_subsystem */