mms_ufun.h

ICCP Toolkit 是在 Tru64下开发Tase.2通信协议的开发包

/************************************************************************/
/* SISCO SOFTWARE MODULE HEADER *****************************************/
/************************************************************************/
/*   (c) Copyright Systems Integration Specialists Company, Inc.,	*/
/*      	  1986 - 1997, All Rights Reserved.		        */
/*									*/
/* MODULE NAME : mms_ufun.h						*/
/* PRODUCT(S)  : MMSEASE						*/
/*									*/
/* MODULE DESCRIPTION : 						*/
/*	This module contains user defined function declarations for	*/
/*	use with MMS. All functions described here must exist in the	*/
/*	user application and are invoked as specified events occur.	*/
/*	The user is to write these functions to accomplish the		*/
/*	application program objective.					*/
/*									*/
/*	This module also contains declarations for the operation 	*/
/*	enable table, the opcode print string table, the indication	*/
/*	service table, and the confirmation service table.  The		*/
/*	index into these tables is the operation opcode.		*/
/*									*/
/* MODIFICATION LOG :							*/
/*  Date     Who   Rev			Comments			*/
/* --------  ---  ------   -------------------------------------------	*/
/* 08/13/97  RKR     01    Format changes				*/
/* 04/02/97  DTL   7.00    MMSEASE 7.0 release. See MODL70.DOC for	*/
/*			   history.					*/
/************************************************************************/

#ifndef MMS_UFUN_INCLUDED
#define MMS_UFUN_INCLUDED

#ifdef __cplusplus
extern "C" {
#endif


/************************************************************************/
/************************************************************************/
/* USER DEFINED CONFIRM FUNCTIONS					*/
/************************************************************************/
/* The functions below are invoked when a confirm is received which	*/
/* matches the channel, invoke ID, opcode, etc.. The passed pointer is	*/
/* the same pointer returned when the request was made. These functions */
/* are called from the 'mms_req_serve' service function.                */
/************************************************************************/

/************************************************************************/
/* MP CONFIRM : invoked when a request initiated via mp_xxx function	*/
/* call. These are 'Paired Primitive' requests.                         */
/* No user action is required, but probably will be taken in most cases */
/* to advance the application task.					*/
/************************************************************************/

ST_VOID u_conf_not_supp		(MMSREQ_PEND *req);

ST_VOID u_mp_conclude_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_cancel_conf	(MMSREQ_PEND *req, ST_BOOLEAN data_pres, 
				ERR_INFO *info);

ST_VOID u_mp_status_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_namelist_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_ident_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_getcl_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_rename_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_getcl_conf		(MMSREQ_PEND *req);

ST_VOID u_mp_initdown_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_download_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_termdown_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_initupl_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_upload_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_termupl_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_rddwn_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_rdupl_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_loaddom_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_storedom_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_deldom_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_getdom_conf	(MMSREQ_PEND *req);

ST_VOID u_mp_crepi_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_delpi_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_start_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_stop_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_resume_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_reset_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_kill_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_getpi_conf		(MMSREQ_PEND *req);

ST_VOID u_mp_read_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_write_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_getvar_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_defvar_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_delvar_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_defscat_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_getscat_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_defvlist_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_getvlist_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_delvlist_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_gettype_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_deftype_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_deltype_conf	(MMSREQ_PEND *req);

ST_VOID u_mp_takectrl_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_relctrl_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_rsstat_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_rspool_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_rsentry_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_defsem_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_delsem_conf	(MMSREQ_PEND *req);

ST_VOID u_mp_output_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_input_conf		(MMSREQ_PEND *req);

ST_VOID u_mp_defec_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_delec_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_geteca_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_repecs_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_altecm_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_trige_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_defea_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_delea_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_geteaa_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_repeas_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_defee_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_delee_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_altee_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_repees_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_geteea_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_evnot_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_ackevnot_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_getas_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_getaes_conf	(MMSREQ_PEND *req);

ST_VOID u_mp_jwrite_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_jread_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_jinit_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_jstat_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_jcreate_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_jdelete_conf	(MMSREQ_PEND *req);

ST_VOID u_mp_obtfile_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_fopen_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_fread_conf		(MMSREQ_PEND *req);
ST_VOID u_mp_fclose_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_frename_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_fdelete_conf	(MMSREQ_PEND *req);
ST_VOID u_mp_fdir_conf		(MMSREQ_PEND *req);

/************************************************************************/
/************************************************************************/
/* MV CONFIRM : invoked when a request initiated via mv_xxx function	*/
/* call. These are Virtual Machine requests.				*/
/*									*/
/* NOTE: The user MUST call the function 'clear_mv_req (req_ptr)' to    */
/* allow the virtual machine to release resources used for the task.	*/
/* Typically this is done in the u_mv_xxx_conf function after the user	*/
/* tasks are complete.							*/
/************************************************************************/

ST_VOID u_mv_init_conf      (MMSREQ_PEND *req);
ST_VOID u_mv_download_conf  (MMSREQ_PEND *req);
ST_VOID u_mv_upload_conf    (MMSREQ_PEND *req);
ST_VOID u_mv_read_conf      (MMSREQ_PEND *req);
ST_VOID u_mv_read_vars_conf (MMSREQ_PEND *req);
ST_VOID u_mv_write_conf     (MMSREQ_PEND *req);
ST_VOID u_mv_write_vars_conf (MMSREQ_PEND *req);
ST_VOID u_mv_deftype_conf   (MMSREQ_PEND *req);
ST_VOID u_mv_fcopy_conf     (MMSREQ_PEND *req);
ST_VOID u_mv_fopen_conf     (MMSREQ_PEND *req);
ST_VOID u_mv_fread_conf     (MMSREQ_PEND *req);
ST_VOID u_mv_fclose_conf    (MMSREQ_PEND *req);


/************************************************************************/
/************************************************************************/
/* USER DEFINED INDICATION FUNCTIONS					*/
/************************************************************************/
/* Most of the functions below are invoked when an indication is pulled */
/* from the pending indication que, called by the MMS service function	*/
/* 'mms_ind_serve'. The user must service the function, either by using */
/* a corresponding 'mv_xxx_resp (req_ptr)' function (allows the virtual */
/* machine to respond), or by using a 'mp_xxx_resp' or 'mp_xxx_err'     */
/* function to respond. 						*/
/*									*/
/* Two functions, u_mmsexcept_ind and u_reject_ind, are called directly */
/* from mms_llp_serve during decode.  The function u_reject_ind is	*/
/* called when a protocol error is found in the received PDU, and the	*/
/* function u_mmsexcept_ind is called when an internal error occurs that*/
/* is not due to a protocol error.  The meaning of the integer argument */
/* to u_mmsexcept_ind is defined in 'mms_defs.h' as the X_xxx series of */
/* defines.								*/
/************************************************************************/

ST_VOID u_ind_not_supp 	(MMSREQ_IND *ind);

ST_VOID u_mmsexcept_ind	(ST_INT chan, ST_RET code);

ST_VOID u_init_ind	(MMSREQ_IND *ind);
ST_VOID u_conclude_ind 	(MMSREQ_IND *ind);
ST_VOID u_cancel_ind	(MMSREQ_IND *ind);
extern ST_VOID (*u_cancel_ind_fun)(MMSREQ_IND *ind);

#ifdef __cplusplus
ST_VOID u_reject_ind	(ST_INT chan, struct ::reject_resp_info *info);
#else
ST_VOID u_reject_ind	(ST_INT chan, REJECT_RESP_INFO *info);
#endif
ST_VOID u_status_ind	(MMSREQ_IND *ind);
ST_VOID u_ustatus_ind 	(MMSREQ_IND *ind);
ST_VOID u_namelist_ind	(MMSREQ_IND *ind);
ST_VOID u_ident_ind 	(MMSREQ_IND *ind);
ST_VOID u_rename_ind 	(MMSREQ_IND *ind);
ST_VOID u_getcl_ind 	(MMSREQ_IND *ind);

ST_VOID u_initdown_ind	(MMSREQ_IND *ind);
ST_VOID u_download_ind	(MMSREQ_IND *ind);
ST_VOID u_termdown_ind	(MMSREQ_IND *ind);
ST_VOID u_initupl_ind	(MMSREQ_IND *ind);
ST_VOID u_upload_ind	(MMSREQ_IND *ind);