liblogging.h

Go to the documentation of this file.

#ifndef __LIB3195_LIBLOGGING_H_INCLUDED__
#define __LIB3195_LIBLOGGING_H_INCLUDED__ 1
#include <stdio.h> /* debug only */

#include "config.h"
#ifdef __cplusplus
extern "C" {
#endif

#define LIBLOGGING_VERSION_MAJOR 0
#define LIBLOGGING_VERSION_MINOR 6
#define LIBLOGGING_VERSION_SUBMINOR 0


enum srRetVal_                          
{
        SR_RET_ERR = -1,                
        SR_RET_REMAIN_WIN_TOO_SMALL = -2,       
        SR_RET_INVALID_HANDLE = -3,     
        SR_RET_INVALID_DESTRUCTOR = -4, 
        SR_RET_NOT_FOUND = - 5,         
    SR_RET_OUT_OF_MEMORY = -6,  
    SR_RET_XML_INVALID_PARAMTAG = -7,   
    SR_RET_XML_INVALID_TERMINATOR = -8, 
        SR_RET_XML_MALFORMED = -9,      
        SR_RET_MISSING_CLOSE_BRACE = -10,       
        SR_RET_XML_MISSING_CLOSETAG = -11,      
        SR_RET_XML_MISSING_OPENTAG = -12,       
        SR_RET_XML_TAG_MISMATCH = -13,  
        SR_RET_XML_INVALID_CDATA_HDR = -14, 
        SR_RET_XML_INVALID_CDATA_TRAIL = -14, 
        SR_RET_PEER_NONOK_RESPONSE = -15, 
        SR_RET_PEER_INVALID_PROFILE = -16, 
        SR_RET_PEER_NO_URI = -17,       
        SR_RET_PEER_NO_PROFILE = -18,
        SR_RET_PEER_NO_GREETING = -19, 
        SR_RET_PEER_DOESNT_SUPPORT_PROFILE = -20, 
        SR_RET_INVALID_FRAME_STATE = -21,       
        SR_RET_PROFILE_ALREADY_SET = -22,       
        SR_RET_INVALID_CHAN_STATE = -23,        
        SR_RET_INVALID_GREETING = -24,          
        SR_RET_INVALID_CHAN0_MESG = -25,        
        SR_RET_START_MISSING_NUMBER = -26,      
        SR_RET_START_INVALID_NUMBER = -27,      
        SR_RET_START_EXISTING_NUMBER = -28,     
        SR_RET_NO_VALUE = -29,                          
        SR_RET_START_EVEN_NUMBER = -30,         
        SR_RET_NO_PROFILE_RQSTD = -31,          
        SR_RET_WARNING_START_NO_PROFMATCH = -32,
        SR_RET_ERR_EVENT_HANDLER_MISSING = -33,
        SR_RET_ACKNO_ZERO = -34,                        
        SR_RET_CHAN_DOESNT_EXIST = -35,         
        SR_RET_ALREADY_LISTENING = -36,         
        SR_RET_INVALID_OPTVAL = -37,            
        SR_RET_INVALID_LIB_OPTION = -38,        
        SR_RET_NULL_POINTER_PROVIDED = -39,     
        SR_RET_PROPERTY_NOT_AVAILABLE = -40,
        SR_RET_UNSUPPORTED_FORMAT = -41,        
        SR_RET_UNALLOCATABLE_BUFFER = -42,      
        SR_RET_PRIO_OUT_OF_RANGE = -43,         
        SR_RET_FACIL_OUT_OF_RANGE = -44,        
        SR_RET_INVALID_TAG = -45,                       
        SR_RET_NULL_MSG_PROVIDED = -46,         
        SR_RET_ERR_RECEIVE = -47,                       
        SR_RET_UNEXPECTED_HDRCMD = -48,         
        SR_RET_PEER_INDICATED_ERROR = -49,      
        SR_RET_PROVIDED_BUFFER_TOO_SMALL = -50,
        SR_RET_INVALID_PARAM = -51,                     
        /* socket error codes */
        SR_RET_SOCKET_ERR = -1001,                      
        SR_RET_CANT_BIND_SOCKET = -1002,        
        SR_RET_INVALID_SOCKET = -1003,          
        SR_RET_CONNECTION_CLOSED = -1004,       
        SR_RET_INVALID_OS_SOCKETS_VERSION = -1005,
        SR_RET_CAN_NOT_INIT_SOCKET = -1006,     
        SR_RET_UXDOMSOCK_CHMOD_ERR = -1007,     
        /* BEEP frame format & other errors */
        SR_RET_INVALID_HDRCMD = -2001,                  
        SR_RET_INVALID_WAITING_SP_CHAN = -2002, 
        SR_RET_INVALID_CHANNO = -2003,                  
        SR_RET_INVALID_WAITING_SP_MSGNO = -2004,
        SR_RET_INVALID_IN_MSGNO = -2005,                
        SR_RET_INVALID_WAITING_SP_MORE = -2006, 
        SR_RET_INVALID_IN_MORE = -2007,                 
        SR_RET_INVALID_WAITING_SP_SEQNO = -2008,
        SR_RET_INVALID_IN_SEQNO = -2009,                
        SR_RET_INVALID_WAITING_SP_SIZE = -2010, 
        SR_RET_INVALID_IN_SIZE = -2011,                 
        SR_RET_INVALID_WAITING_SP_ANSNO = -2012,
        SR_RET_INVALID_IN_ANSNO = -2013,                
        SR_RET_INVALID_WAITING_HDRCR = -2014,   
        SR_RET_INVALID_WAITING_HDRLF = -2015,   
        SR_RET_INVALID_IN_PAYLOAD = -2016,              
        SR_RET_INVALID_WAITING_END1 = -2017,    
        SR_RET_INVALID_WAITING_END2 = -2018,    
        SR_RET_INVALID_WAITING_END3 = -2019,    
        SR_RET_INVALID_WAITING_END4 = -2020,    
        SR_RET_INVALID_WAITING_END5 = -2021,    
        SR_RET_INVALID_WAITING_SP_ACKNO = -2022,
        SR_RET_INVALID_WAITING_SP_WINDOW = -2023,
        SR_RET_INAPROPRIATE_HDRCMD = -2024,             
        SR_RET_OVERSIZED_FRAME = -2025,                 
        /* and finally the OK state... */
        SR_RET_OK = 0                   
};
typedef enum srRetVal_ srRetVal;


typedef unsigned SBchannel; 
typedef unsigned SBseqno; 
typedef unsigned SBansno; 
typedef unsigned SBsize; 
typedef unsigned SBmsgno; 
typedef unsigned SBackno; 
typedef unsigned SBwindow; 
enum srObjectID
{
        OID_Freed = -1,         
        OID_Invalid = 0,        
        /* The 0xCDAB is a debug aid. It helps us find object IDs in memory
         * dumps (on X86, this is ABCD in the dump ;)
         * If you are on an embedded device and you would like to save space
         * make them 1 byte only.
         */
        OIDsbFram = 0xCDAB0001,
        OIDsbChan = 0xCDAB0002,
        OIDsbMesg = 0xCDAB0003,
        OIDsbSess = 0xCDAB0004,
        OIDsbSock = 0xCDAB0005,
        OIDsbProf = 0xCDAB0006,
        OIDsrAPI  = 0xCDAB0007,
        OIDsrSLMG = 0xCDAB0008,
        OIDsbNVTR = 0xCDAB0009,
        OIDsbNVTE = 0xCDAB000A,
        OIDsbStrB = 0xCDAB000B,
        OIDsbLstn = 0xCDAB000C,
        OIDsbPSSR = 0xCDAB000D,
        OIDsbPSRC = 0xCDAB000E
};
typedef enum srObjectID srObjID;


enum srOPTION3195Profiles_
{
        USE_3195_PROFILE_ANY = 1,
        USE_3195_PROFILE_RAW_ONLY = 2,
        USE_3195_PROFILE_COOKED_ONLY = 3
};
typedef enum srOPTION3195Profiles_ srOPTION3195Profiles;

enum srOPTION
{
        srOPTION_INVALID = 0,           
        srOPTION_CALL_OS_SOCKET_INITIALIZER = 1,
         srOPTION_3195_ALLOWED_CLIENT_PROFILES = 2,
         srOPTION_LISTEN_UDP = 3,
     srOPTION_UPD_LISTENPORT = 4,
     srOPTION_LISTEN_UXDOMSOCK = 5,
     srOPTION_UXDOMSOCK_LISTENAME = 6,
     srOPTION_LISTEN_BEEP = 7,
     srOPTION_BEEP_LISTENPORT = 8
};
typedef enum srOPTION SRoption;

#if DEBUGLEVEL > 0
#define SRFREEOBJ(x) {(x)->OID = OID_Freed; free(x);}
#else
#define SRFREEOBJ(x) free(x)
#endif

enum BEEPHdrID_ 
{
        BEEPHDR_UNKNOWN = 0,
        BEEPHDR_ANS,
        BEEPHDR_ERR,
    BEEPHDR_MSG,
        BEEPHDR_NUL,
        BEEPHDR_RPY,
        BEEPHDR_SEQ
};
typedef enum BEEPHdrID_ BEEPHdrID;


#define BEEP_DEFAULT_MIME_HDR "Content-type: application/beep+xml\r\n"

#ifdef __cplusplus
}
#endif
#include "srAPI.h"

#endif

---