agt_ses.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_agt_ses
#define _H_agt_ses
/*  FILE: agt_ses.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-jun-06    abb      Begun.
*/

#include <sys/select.h>

#include <xmlstring.h>

#ifndef _H_getcb
#include "getcb.h"
#endif

#ifndef _H_ncxconst
#include "ncxconst.h"
#endif

#ifndef _H_ses
#include "ses.h"
#endif

#ifndef _H_status
#include "status.h"
#endif

#ifndef _H_val
#include "val.h"
#endif

#ifdef __cplusplus
extern "C" {
#endif

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

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


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

/* what is this hack? */
extern const char *term_reason_str (ses_term_reason_t termreason);


extern status_t
    agt_ses_init (void);


extern void
    agt_ses_cleanup (void);


extern ses_cb_t *
    agt_ses_new_dummy_session (void);


extern status_t
    agt_ses_set_dummy_session_acm (ses_cb_t *dummy_session,
                                   ses_id_t  use_sid);



extern void
    agt_ses_free_dummy_session (ses_cb_t *scb);


#ifdef WITH_COAP

extern ses_cb_t *
    agt_ses_new_coap_session (void);


extern void
    agt_ses_free_coap_session (ses_cb_t *scb);

#endif  // WITH_COAP


#if defined(WITH_SNMP) && defined(WITH_RESTCONF)

extern ses_cb_t *
    agt_ses_new_snmp_session (void);


extern void
    agt_ses_free_snmp_session (ses_cb_t *scb);

#endif  // WITH_SNMP


extern ses_cb_t *
    agt_ses_new_session (ses_transport_t transport,
             int fd);


extern ses_cb_t *
    agt_ses_new_session_tls (ses_transport_t transport,
                             int fd,
                             const char *client_addr);


extern void
    agt_ses_free_session (ses_cb_t *scb);


extern void
    agt_ses_free_session2 (ses_cb_t *scb,
                           boolean clear_locks);


extern boolean
    agt_ses_session_id_valid (ses_id_t  sid);


extern boolean
    agt_ses_request_close (ses_cb_t *scb,
               ses_id_t killedby,
               ses_term_reason_t termreason);


#ifdef PTHREADS

extern void
    agt_ses_thread_kill_session (ses_cb_t *scb,
                 ses_id_t killedby,
                 ses_term_reason_t termreason);
#endif  // PTHREADS


extern void
    agt_ses_kill_session (ses_cb_t *scb,
              ses_id_t killedby,
              ses_term_reason_t termreason);


extern boolean
   agt_ses_process_first_ready_by_sid (ses_id_t sid);


extern boolean
    agt_ses_process_first_ready (boolean ycontrol);


#ifdef PTHREADS

extern void
    agt_ses_check_timeouts (ses_id_t sid);

#else

extern void
    agt_ses_check_timeouts (void);

#endif  // PTHREADS


extern boolean
    agt_ses_ssh_port_allowed (uint16 port);


extern void
    agt_ses_fill_writeset (fd_set *fdset,
               int *maxfdnum);


extern status_t
    agt_ses_get_inSessions (ses_cb_t *scb,
                getcb_mode_t cbmode,
                const val_value_t *virval,
                val_value_t  *dstval);


extern status_t
    agt_ses_get_inBadHellos (ses_cb_t *scb,
                 getcb_mode_t cbmode,
                 const val_value_t *virval,
                 val_value_t  *dstval);


extern status_t
    agt_ses_get_inRpcs (ses_cb_t *scb,
            getcb_mode_t cbmode,
            const val_value_t *virval,
            val_value_t  *dstval);


extern status_t
    agt_ses_get_inBadRpcs (ses_cb_t *scb,
               getcb_mode_t cbmode,
               const val_value_t *virval,
               val_value_t  *dstval);


extern status_t
    agt_ses_get_outRpcErrors (ses_cb_t *scb,
                  getcb_mode_t cbmode,
                  const val_value_t *virval,
                  val_value_t  *dstval);



extern status_t
    agt_ses_get_outNotifications (ses_cb_t *scb,
                  getcb_mode_t cbmode,
                  const val_value_t *virval,
                  val_value_t  *dstval);


extern status_t
    agt_ses_get_droppedSessions (ses_cb_t *scb,
                                 getcb_mode_t cbmode,
                                 const val_value_t *virval,
                                 val_value_t  *dstval);



extern status_t
    agt_ses_get_session_inRpcs (ses_cb_t *scb,
                                getcb_mode_t cbmode,
                                const val_value_t *virval,
                                val_value_t  *dstval);


extern status_t
    agt_ses_get_session_inBadRpcs (ses_cb_t *scb,
                                   getcb_mode_t cbmode,
                                   const val_value_t *virval,
                                   val_value_t  *dstval);


extern status_t
    agt_ses_get_session_outRpcErrors (ses_cb_t *scb,
                                      getcb_mode_t cbmode,
                                      const val_value_t *virval,
                                      val_value_t  *dstval);


extern status_t
    agt_ses_get_session_outNotifications (ses_cb_t *scb,
                                          getcb_mode_t cbmode,
                                          const val_value_t *virval,
                                          val_value_t  *dstval);


extern void
    agt_ses_invalidate_session_acm_caches (void);


extern ses_cb_t*
    agt_ses_get_session_for_id (ses_id_t sid);


extern uint32
    agt_ses_mgmt_session_count (void);



#ifdef WITH_YP_HA

extern void
    agt_ses_go_active (void);

#endif // WITH_YP_HA


#ifdef WITH_YP_HA

extern void
    agt_ses_go_standby (void);


extern void
    agt_ses_remove_subsys (ses_id_t sid);

#endif  // WITH_YP_HA


extern boolean
    agt_ses_max_cli_sessions (void);


extern void
    agt_ses_set_max_sessions (uint16 val);


extern void
    agt_ses_set_max_cli_sessions (uint16 val);


extern void
    agt_ses_set_hello_timeout (uint32 val);


extern void
    agt_ses_set_idle_timeout (uint32 val);


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

#endif            /* _H_agt_ses */