subsys_util.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
 * Copyright (c) 2012 - 2025, 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_subsys_util
#define _H_subsys_util
 
/*  FILE: subsys_util.h
*********************************************************************
*                                   *
*            P U R P O S E                  *
*                                   *
*********************************************************************/
 
/*********************************************************************
*                                   *
*          C H A N G E   H I S T O R Y              *
*                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
24-oct-12    abb      Begun; split from subsystem.c
 
*/
 
#ifndef _H_subsystem
#include "subsystem.h"
#endif
 
#ifndef _H_status
#include "status.h"
#endif
 
#ifndef _H_subsys_magic
#include "subsys_magic.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                                                   *
*                       C O N S T A N T S                           *
*                                                                   *
*********************************************************************/
 
 
#define SERVER_MAP_FILE_LINELEN  1024
 
#define SERVER_MAP_WILDCARD "*"
 
#define SERVER_MAP_ID_MAXLEN 64
 
 
/********************************************************************
*                                   *
*                T Y P E S                  *
*                                   *
*********************************************************************/
 
 
typedef struct subsys_cb_t_ {
 
    const char *request_uri;
 
    const char *request_method;
 
    const char *content_type;
 
    const char *content_length;
 
    const char *modified_since;
 
    const char *unmodified_since;
 
    const char *match;
 
    const char *none_match;
 
    const char *http_accept;
 
    const char *message_id;
 
    const char *user;
 
    const char *ha_server_id;
 
    char **envp;
 
    const char *ha_server_addr;
 
    uint16 ha_server_port;
 
    subsys_stdin_fn_t stdin_fn;
 
    subsys_stdout_fn_t stdout_fn;
 
    int32 content_len;
 
    char *server_root_mapfile;
 
    char *server_root;
 
    boolean server_root_from_env;
 
    char *client_addr;
 
    char *port;
 
    char *server_addr;
 
    int ncxsock;
 
    boolean ncxconnect;
 
    boolean nonblocking;
 
    boolean nonblocking_set_ok;
 
    boolean no_connect;
 
    boolean yp_ha_mode;
 
    boolean extern_mode;
 
    proto_id_t proto_id;
 
    const char *subsys_id;
 
    int traceLevel;
 
    FILE *errfile;
 
    fd_set fds;
 
    char msgbuff[SUBSYS_BUFFLEN];
 
    /* flag indicating signal handler installed */
    boolean signal_init_done;
 
    /* flag indicating program termination requested */
    boolean shutdown_requested;
 
    /* flag indicating this is a RESTCONF session is SSE mode */
    boolean restconf_sse_mode;
 
    /* SSE_KEEPALIVE env parameter */
    const char *sse_keepalive;
 
    /* timeout value for select function to use for SSE keepalives
     * default=0; no timeout;
     * causes an SSE comment to be sent to the client
     */
    uint16  restconf_sse_timeout;
 
} subsys_cb_t;
 
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
 
extern status_t
    get_ssh_parms (subsys_cb_t *cb);
 
 
extern status_t
    get_server_root_mapfile (subsys_cb_t *cb);
 
 
extern status_t
    start_connection (subsys_cb_t *cb);
 
 
extern status_t
    send_cli_ncxconnect (subsys_cb_t *cb);
 
 
extern void
    init_subsys_cb (subsys_cb_t *cb);
 
 
extern void
    clean_subsys_cb (subsys_cb_t *cb);
 
 
extern void
    configure_cli_parms(subsys_cb_t *cb,
                        int argc,
                        char **argv);
 
 
extern status_t
    start_subsys_ypshell (int *retfd);
 
 
extern status_t
    start_subsys_tcp_ncx (int *retfd,
                          const char *user);
 
 
extern status_t
    start_subsys_extern_tcp_ncx (int *retfd,
                                 const char *user,
                                 const char *addr,
                                 unsigned int portnum);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_subsys_util */