agt_ncxserver.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
 * Copyright (c) 2012 - 2024, 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_agt_ncxserver
#define _H_agt_ncxserver
 
/*  FILE: agt_ncxserver.h
*********************************************************************
*                                                                   *
*                        P U R P O S E                              *
*                                                                   *
*********************************************************************/
 
/*********************************************************************
*                                                                   *
*                  C H A N G E   H I S T O R Y                      *
*                                                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
11-jan-07    abb      Begun
 
*/
 
#ifndef _H_agt
#include "agt.h"
#endif
 
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
 
#ifndef _H_ses
#include "ses.h"
#endif
 
#ifndef _H_status_enum
#include "status_enum.h"
#endif
 
#ifndef _H_pthread
#include "pthread.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                                                   *
*                        C O N S T A N T S                          *
*                                                                   *
*********************************************************************/
 
 
/********************************************************************
*                                                                   *
*                            T Y P E S                              *
*                                                                   *
*********************************************************************/
 
 
/********************************************************************
*                                                                   *
*                       V A R I A B L E S                           *
*                                                                   *
*********************************************************************/
 
/********************************************************************
*                                                                   *
*                       F U N C T I O N S                           *
*                                                                   *
*********************************************************************/
 
 
 
extern status_t
    agt_ncxserver_run (void);
 
 
extern status_t
    agt_ncxserver_run_ycontrol (boolean ycontrol,
                                const xmlChar *txid_str);
 
 
extern status_t
    agt_ncxserver_run_extloop (boolean ycontrol,
                               const xmlChar *txid_str,
                               boolean extloop_mode);
 
 
extern void
    agt_ncxserver_clear_fd (int fd);
 
 
extern void
    agt_ncxserver_exit_ycontrol_mode (const xmlChar *txid_str,
                                      agt_exit_mode_t exitmode);
 
 
 
extern void
    agt_ncxserver_exit_ycontrol_mode_edit (const xmlChar *txid_str,
                                           agt_exit_mode_t exitmode,
                                           boolean need_reverse_edit);
 
 
extern agt_exit_mode_t
    agt_ncxserver_get_exit_mode (const xmlChar *txid_str);
 
 
#ifdef PTHREADS
 
extern thd_tcb_t *
    agt_ncxserver_get_timer_tcb (void);
 
 
#ifndef TEST_PTHREADS
extern boolean
    agt_ncxserver_thread_clear_session (ses_id_t sid,
                                        ses_id_t killedby,
                                        ses_term_reason_t termreason);
 
 
extern void
    agt_ncxserver_thd_ses_cleanup (thd_type_t thd_type);
 
 
extern boolean
    agt_ncxserver_thread_cancel_cc (ses_id_t sid, ncx_confirm_event_t event);
 
 
#else // TEST_PTHREADS
/* Stub definitions for integ-test image build */
 
extern bool agt_ncxserver_thread_clear_session (int sid,
                                                int killedby,
                                                int termreason);
 
extern bool agt_ncxserver_thread_cancel_cc (int sid, int event);
 
/* Stub definitions for integ-test image build */
#endif // TEST_PTHREADS
 
#endif // PTHREADS
 
 
extern status_t
    agt_ncxserver_inject_session (ses_cb_t *scb,
                                  int newfd);
 
 
extern void
    agt_ncxserver_cleanup_extloop (void);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_agt_ncxserver */