ntscclsh.h

ipt网关源码

//////////////////////////////////////////////////////////////////////////////
// File Name: NTSCCLSH.H
//
// This header file contains interface definitions for the data types and
// functions that are needed for using/implementing NETTSCCLUSTER over DM3CLUSTER
////////////////////////////////////////////////////////////////////////////
//  THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF 
//  ANY KIND EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED 
//  TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
//  PARTICULAR PURPOSE.
//
//  Copyright (c) 1997  Dialogic Corporation.  All Rights Reserved.
////////////////////////////////////////////////////////////////////////////
#ifndef  _NTSCCLSH_H
#define  _NTSCCLSH_H

#include "NTSCClst.h"
#include "DM3NTSC.h"



#ifdef   __cplusplus
extern   "C" {
#endif   __cplusplus


////////////////////////////////////////////////////////////////////////////////////////
//        NAME : NETTSCClusterEvtHndlr 
// DESCRIPTION : Method that handles all the reply messages for this lpCluster
//       INPUT : lpComp - pointer to the Dm3Comp object associated with the Dm3Cluster 
//                        object
//               ulCmdType - type of the message that initiated this reply message
//               ulReplyType - type of the reply message
//               lpReplyMsg - pointer to the reply message.
//      OUTPUT : NONE
//     RETURNS : LPVOID - pointer to a VOID object (manipulated by the user of Dm3Cluster).  
//    CAUTIONS : NONE 
//////////////////////////////////////////////////////////////////////////////////////////
LPVOID  NETTSCClusterEvtHndlr(LPDM3COMP lpComp,
                              ULONG     ulCmdType,
                              ULONG     ulReplyType,
                              QMsgRef   lpReplyMsg);


//////////////////////////////////////////////////////////////////////////////
//        NAME : NETTSCClusterAllocateCmplt
// DESCRIPTION : The internal method called when the given lpCluster object 
//               allocation completes. * The cluster allocation is initiated 
//               by the Dm3ClusterAllocate() method If the allocation complete
//               is successful (indicated by the dwErrorCode), then the 
//               lpCluster object will have a valid Cluster FW address.  
//       INPUT : lpCluster - pointer to the DM3CLUSTER object 
//               qcdAddr - a valid QCompDesc if the error code == NO_ERROR;
//               dwErrorCode - error code
//      OUTPUT : NONE 
//     RETURNS : pointer to a VOID object 
//    CAUTIONS :  
///////////////////////////////////////////////////////////////////////////////
LPVOID NETTSCClusterAllocateCmplt(LPDM3CLUSTER lpCluster,
                                  QCompDesc    qcdAddr,
                                  DWORD        dwErrorCode);


//////////////////////////////////////////////////////////////////////////////
//        NAME : NETTSCClusterCompByAttrCmplt(lpCluster,qcdAddr, dwErrorCode)
//
// DESCRIPTION : The internal method called when the component
//               instances for the given lpCluster object were found.
//       INPUT : lpCluster - pointer to the DM3CLUSTER object 
//               qcdAddr - a valid QCompDesc if the error code == NO_ERROR;
//               dwErrorCode - error code
//      OUTPUT : NONE 
//     RETURNS : pointer to a VOID object 
//    CAUTIONS :  
///////////////////////////////////////////////////////////////////////////////
LPVOID NETTSCClusterCompByAttrCmplt(LPDM3CLUSTER lpCluster,
                                    QCompDesc    qcdAddr,
                                    DWORD        dwErrorCode);


//////////////////////////////////////////////////////////////////////////////////
//        NAME :  OnNETTSCClusterGetXmitTimeSlotCmplt(lpCluster, usTimeslot, dwErrorCode)
// DESCRIPTION :  This method is called when the GetXmitTimeSlot event completes.
//       INPUT :  lpCluster - pointer to the DM3CLUSTER object
//                usTimeSlot - transmit timeslot assigned to the CTBus comp' port
//                in this cluster if the dwErrorcode = NO_ERROR, 
//                 otherwise un defined.
//                dwErrorCode - error code associated with this event
//      OUTPUT :  NONE
//     RETURNS :  pointer to a VOID object 
//    CAUTIONS :  NONE
////////////////////////////////////////////////////////////////////////////////////
LPVOID OnNETTSCClusterGetXmitTimeSlotCmplt(LPDM3CLUSTER lpCluster,
                                           USHORT       usTimeSlot,
                                           DWORD        dwErrorCode);


///////////////////////////////////////////////////////////////////////////
//        NAME :  NETTSCClusterSlotAssignCmplt(lpCluster, dwErrorCode)
// DESCRIPTION :  The internal method called when the given lpCluster 
//                object timeslot assignment to the CTBus input port 
//                completes. 
//                This method is initiated  by the Dm3ClusterListen() method.
//       INPUT :  lpCluster - pointer to a DM3CLUSTER object
//                dwErrorCode - error code
//      OUTPUT :  NONE
//     RETURNS :  pointer to a VOID object
//    CAUTIONS :  
/////////////////////////////////////////////////////////////////////////////
LPVOID NETTSCClusterSlotAssignCmplt(LPDM3CLUSTER lpCluster,
                                    DWORD dwErrorCode);

///////////////////////////////////////////////////////////////////////////////////
//        NAME :  OnNETTSCClusterGetCompCmplt(lpCluster, qcdCompAddr, dwErrorCode)
// DESCRIPTION :  The method called when getting a component instance from the given 
//                lpCluster completes. This method is initiated using 
//                .Dm3ClusterGetComp()
//                If the get component is successful (indicated by the dwErrorCode),
//                then the qcdCompFwAddr is a valid Comp FW address. The component 
//                pertains to the last queried component using Dm3ClusterGetComp()
//                method.
//                This method must be filled in by the Dm3Cluster user.
//       INPUT :  lpCluster - pointer to the Dm3Cluster object
//                qcdCompAddr - contains the address of the component instance
//                dwErrorCode - errorCode identifying the error 
//      OUTPUT :  NONE
//     RETURNS :  pointer to a VOID object 
//    CAUTIONS :  
///////////////////////////////////////////////////////////////////////////////////
LPVOID OnNETTSCClusterGetCompCmplt(LPDM3CLUSTER lpCluster,
                                   QCompDesc    qcdCompAddr,
                                   DWORD        dwErrorCode);


//////////////////////////////////////////////////////////////////////////////////////////
//        NAME : NETTSCClusterFindCmplt
// DESCRIPTION : The internal method called when the given lpCluster object 
//               find completes.  The cluster find is initiated by the 
//               Dm3ClusterFind() method If the cluster is successfully found
//               (indicated by the dwErrorCode), then the lpCluster object will have 
//               a valid Cluster FW address.  
//       INPUT : lpCluster - pointer to the DM3CLUSTER object 
//               qcdAddr - a valid QCompDesc if the error code == NO_ERROR;
//               dwErrorCode - error code
//      OUTPUT : NONE 
//     RETURNS : pointer to a VOID object 
//    CAUTIONS :  
////////////////////////////////////////////////////////////////////////////////////////////
LPVOID NETTSCClusterFindCmplt(LPDM3CLUSTER lpCluster,
                              QCompDesc    qcdAddr,
                              DWORD        dwErrorCode);


//////////////////////////////////////////////////////////////////////////////////////////
//        NAME :  ClusterDeactivateCmplt
// DESCRIPTION :  The internal method called when the given lpCluster object 
//                dactivation of  the CTBus oputput port completes. 
//                This method is initiated  by the Dm3ClusterListen() method.
//       INPUT :  lpCluster - pointer to a DM3CLUSTER object
//                dwErrorCode - error code
//      OUTPUT :  NONE
//     RETURNS :  pointer to a VOID object
//    CAUTIONS :  
///////////////////////////////////////////////////////////////////////////////////////////
LPVOID NetTSCClusterDeactivateCmplt(LPDM3CLUSTER lpCluster,
									DWORD dwErrorCode);


////////////////////////////////////////////////////////////////////////////////////////
//        NAME : DecodeClusterMsgReply 
// DESCRIPTION : Method that handles all the reply messages for this lpCluster
//       INPUT : lpReplyMsg - pointer to the reply message.
//               ulReplyType - reply type
//               pfComplete  - pointer to complete flag
//               pErrorCode  - poiner to error code, in case of error
//               pTimeSlot   - pointer to time slot number
//               pqcdAddr    - pointer to componenmt descriptor
//      OUTPUT : NONE
//     RETURNS : LPVOID - pointer to a VOID object (manipulated by the user of Dm3Cluster).  
//    CAUTIONS : NONE 
//////////////////////////////////////////////////////////////////////////////////////////
LPVOID  DecodeClusterMsgReply(QMsgRef   lpReplyMsg,
                              ULONG     ulReplyType,
                              BOOL      *pfComplete,
                              DWORD     *pErrorCode,
                              USHORT    *pTimeSlot,
                              QCompDesc *pqcdAddr);


#ifdef   __cplusplus
}
#endif   __cplusplus


#endif _NTSCCLSH_H