agt_callhome.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017 - 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.
 */
#ifdef WITH_CALLHOME
#ifndef _H_agt_callhome
#define _H_agt_callhome

/*  FILE: agt_callhome
*********************************************************************
*                                                                   *
*                        P U R P O S E                              *
*                                                                   *
*********************************************************************/

/*********************************************************************
*                                                                   *
*                  C H A N G E   H I S T O R Y                      *
*                                                                   *
*********************************************************************

date         init     comment
----------------------------------------------------------------------
15-jan-17    abb      Begun
*/

#include <xmlstring.h>
#include <unistd.h>

#ifndef _H_agt
#include "agt.h"
#endif

#ifndef _H_dlq
#include "dlq.h"
#endif

#ifndef _H_status_enum
#include "status_enum.h"
#endif

#ifdef __cplusplus
extern "C" {
#endif

/********************************************************************
*                                                                   *
*                        C O N S T A N T S                          *
*                                                                   *
*********************************************************************/

/********************************************************************
*                                                                   *
*                            T Y P E S                              *
*                                                                   *
*********************************************************************/

typedef struct agt_callhome_cb_t_ {
    dlq_hdr_t qhdr;

    const xmlChar *ch_sshd_path;

    const xmlChar *ch_subsys_path;

    xmlChar       *ch_name;

    xmlChar       *ch_client_addr;

    xmlChar       *ch_sshd_config;

    uint16         ch_client_port;

    uint16         ch_retry_interval;

    uint16         ch_retry_max;

    agt_ch_proto_t ch_proto;

    boolean        ch_reconnect;

    boolean        ch_enabled;

    boolean        ch_connecting;

    boolean        ch_connected;

    boolean        ch_from_cli;

    uint16         ch_retry_count;

    uint32         ch_timer_id;

    pid_t          ch_pid;
} agt_callhome_cb_t;


/********************************************************************
*                                                                   *
*                       F U N C T I O N S                           *
*                                                                   *
*********************************************************************/


extern status_t
    agt_callhome_init (void);


extern status_t
    agt_callhome_init_postcli (void);


extern status_t
    agt_callhome_init2 (void);


extern void
    agt_callhome_cleanup (void);


extern boolean
    agt_callhome_connecting (const xmlChar *addr);


extern status_t
    agt_callhome_add_server_cli (const xmlChar *valstr,
                                 agt_ch_proto_t ch_proto);


extern status_t
    agt_callhome_add_server (const xmlChar *ch_name,
                             const xmlChar *ch_addr,
                             uint16 ch_port,
                             agt_ch_proto_t ch_proto,
                             boolean start_now);



extern status_t
    agt_callhome_remove_server (const xmlChar *ch_name);


extern status_t
    agt_callhome_remove_all_servers (void);


#ifdef __cplusplus
}  /* end extern 'C' */
#endif

#endif      /* _H_agt_callhome */

#endif   // WITH_CALLHOME