beepsession.h

Go to the documentation of this file.

#ifndef __LIB3195_BEEPSESSION_H_INCLUDED__
#define __LIB3195_BEEPSESSION_H_INCLUDED__ 1
#define sbSessCHECKVALIDOBJECT(x) {assert((x) != NULL); assert((x)->OID == OIDsbSess);}

struct sbMesgObject;

#include "beepchannel.h"
#include "beepprofile.h"

#if FEATURE_LISTENER == 1

        enum sbSessState_
        {
                sbSESSSTATE_OPEN,
                sbSESSSTATE_CLOSED,                     
                sbSESSSTATE_UNKNOWN = 0         
        };
        typedef enum sbSessState_ sbSessState;

        enum sbSessTXState_
        {
                sbSESSTXSTATE_NO_TX_PENDING,    
                sbSESSTXSTATE_IN_TX,                    
                sbSESSTXSTATE_UNKNOWN = 0               
        };
        typedef enum sbSessTXState_ sbSessTXState;
#endif

struct sbChanObject;
struct sbChanObject;
struct sbFramObject;
struct sbNVTRObject;
struct sbSessObject 
{       
        srObjID OID;                                            
        srRetVal iLastErr;                                      
        struct sbSockObject *pSock;                     
        struct sbChanObject *pChan0;            
        struct sbNVTRObject *pChannels;         
        struct sbNVTRObject* pRXQue;            
        struct sbNVTRObject *pRemoteProfiles; 
        srRetVal (*SendFramMethod)(struct sbSessObject *, struct sbFramObject *, struct sbChanObject *); 
        struct sbNVTRObject *pProfilesSupported;
#if FEATURE_LISTENER == 1
        sbSessState iState;                                             
        sbSessTXState iTXState;                                 
        struct sbNVTRObject *pSendQue;                  
        struct sbFramObject *pRecvFrame;                
        int     bNeedData;                                                      
#endif
};
typedef struct sbSessObject sbSessObj;

sbSessObj* sbSessOpenSession(char* pszRemotePeer, int iPort, struct sbNVTRObject *pProfSupported);
srRetVal sbSessCloseSession(sbSessObj *pThis);


/* The following three macros could also be inline code.
 * For now, I have kept them to be macros to make 
 * facilitate porting.
 */

#define sbSessGetLastError(pThis) pThis->iLastErr

#define sbSessSetLastError(pThis, iRet) pThis->iLastErr = iRet

#define sbSessResetLastError(pThis) pThis->iLastErr = SR_RET_OK

struct sbChanObject* sbSessRetrChanObj(sbSessObj *pThis, SBchannel uChanNo);

struct sbFramObject* sbSessRecvFram(sbSessObj* pThis, struct sbChanObject  *pChan);

struct sbChanObject* sbSessOpenChan(sbSessObj* pThis);

srRetVal sbSessCloseChan(sbSessObj *pThis, struct sbChanObject *pChan);

srRetVal sbSessCloseSession(sbSessObj *pThis);

srRetVal sbSessDoReceive(sbSessObj *pThis, int bMustRcvPayloadFrame);

srRetVal sbSessSendFram(sbSessObj *pThis, struct sbFramObject *pFram, struct sbChanObject *pChan);

void sbSessDestroy(sbSessObj *pThis);

srRetVal sbSessRemoteOpen(sbSessObj **pThis, sbSockObj *pSock, struct sbNVTRObject *pProfSupported);

void sbSessAbort(sbSessObj *pThis);

srRetVal sbSessProcessGreeting(struct sbSessObject *pThis, struct sbMesgObject *pMesg);

srRetVal sbSessSendGreeting(struct sbSessObject* pSess, struct sbNVTRObject *pProfsSupported);


#endif

---