Home | History | Annotate | Download | only in include
      1 /**
      2  * This file is part of the mingw-w64 runtime package.
      3  * No warranty is given; refer to the file DISCLAIMER within this package.
      4  */
      5 
      6 #ifndef _INC_WINSNMP
      7 #define _INC_WINSNMP
      8 
      9 #include <winapifamily.h>
     10 
     11 #if WINAPI_FAMILY_PARTITION (WINAPI_PARTITION_DESKTOP)
     12 
     13 #ifndef _INC_WINDOWS
     14 #include <windows.h>
     15 #define _INC_WINDOWS
     16 #endif
     17 
     18 #include <limits.h>
     19 
     20 #ifdef __cplusplus
     21 extern "C" {
     22 #endif
     23 
     24   typedef HANDLE HSNMP_SESSION,*LPHSNMP_SESSION;
     25   typedef HANDLE HSNMP_ENTITY,*LPHSNMP_ENTITY;
     26   typedef HANDLE HSNMP_CONTEXT,*LPHSNMP_CONTEXT;
     27   typedef HANDLE HSNMP_PDU,*LPHSNMP_PDU;
     28   typedef HANDLE HSNMP_VBL,*LPHSNMP_VBL;
     29   typedef unsigned char smiBYTE,*smiLPBYTE;
     30 
     31 #if ULONG_MAX == 4294967295U
     32   typedef signed __LONG32 smiINT,*smiLPINT;
     33   typedef smiINT smiINT32,*smiLPINT32;
     34   typedef unsigned __LONG32 smiUINT32,*smiLPUINT32;
     35 #elif UINT_MAX == 4294967295U
     36   typedef int smiINT,*smiLPINT;
     37   typedef smiINT smiINT32,*smiLPINT32;
     38   typedef unsigned int smiUINT32,*smiLPUINT32;
     39 #else
     40 #error can not define smiINT and smiUINT
     41 #endif
     42 
     43   typedef struct {
     44     smiUINT32 len;
     45     smiLPBYTE ptr;
     46   } smiOCTETS,*smiLPOCTETS;
     47 
     48   typedef const smiOCTETS *smiLPCOCTETS;
     49   typedef smiOCTETS smiBITS,*smiLPBITS;
     50 
     51   typedef struct {
     52     smiUINT32 len;
     53     smiLPUINT32 ptr;
     54   } smiOID,*smiLPOID;
     55 
     56   typedef const smiOID *smiLPCOID;
     57   typedef smiOCTETS smiIPADDR,*smiLPIPADDR;
     58   typedef smiUINT32 smiCNTR32,*smiLPCNTR32;
     59   typedef smiUINT32 smiGAUGE32,*smiLPGAUGE32;
     60   typedef smiUINT32 smiTIMETICKS,*smiLPTIMETICKS;
     61   typedef smiOCTETS smiOPAQUE,*smiLPOPAQUE;
     62   typedef smiOCTETS smiNSAPADDR,*smiLPNSAPADDR;
     63 
     64   typedef struct {
     65     smiUINT32 hipart;
     66     smiUINT32 lopart;
     67   } smiCNTR64,*smiLPCNTR64;
     68 
     69 #define ASN_UNIVERSAL (0x00)
     70 #define ASN_APPLICATION (0x40)
     71 #define ASN_CONTEXT (0x80)
     72 #define ASN_PRIVATE (0xc0)
     73 #define ASN_PRIMITIVE (0x00)
     74 #define ASN_CONSTRUCTOR (0x20)
     75 
     76 #define SNMP_SYNTAX_SEQUENCE (ASN_UNIVERSAL | ASN_CONSTRUCTOR | 0x10)
     77 #define SNMP_SYNTAX_INT (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x02)
     78 #define SNMP_SYNTAX_BITS (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x03)
     79 #define SNMP_SYNTAX_OCTETS (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x04)
     80 #define SNMP_SYNTAX_NULL (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x05)
     81 #define SNMP_SYNTAX_OID (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x06)
     82 #define SNMP_SYNTAX_INT32 SNMP_SYNTAX_INT
     83 #define SNMP_SYNTAX_IPADDR (ASN_APPLICATION | ASN_PRIMITIVE | 0x00)
     84 #define SNMP_SYNTAX_CNTR32 (ASN_APPLICATION | ASN_PRIMITIVE | 0x01)
     85 #define SNMP_SYNTAX_GAUGE32 (ASN_APPLICATION | ASN_PRIMITIVE | 0x02)
     86 #define SNMP_SYNTAX_TIMETICKS (ASN_APPLICATION | ASN_PRIMITIVE | 0x03)
     87 #define SNMP_SYNTAX_OPAQUE (ASN_APPLICATION | ASN_PRIMITIVE | 0x04)
     88 #define SNMP_SYNTAX_NSAPADDR (ASN_APPLICATION | ASN_PRIMITIVE | 0x05)
     89 #define SNMP_SYNTAX_CNTR64 (ASN_APPLICATION | ASN_PRIMITIVE | 0x06)
     90 #define SNMP_SYNTAX_UINT32 (ASN_APPLICATION | ASN_PRIMITIVE | 0x07)
     91 #define SNMP_SYNTAX_UNSIGNED32 SNMP_SYNTAX_GAUGE32
     92 #define SNMP_SYNTAX_NOSUCHOBJECT (ASN_CONTEXT | ASN_PRIMITIVE | 0x00)
     93 #define SNMP_SYNTAX_NOSUCHINSTANCE (ASN_CONTEXT | ASN_PRIMITIVE | 0x01)
     94 #define SNMP_SYNTAX_ENDOFMIBVIEW (ASN_CONTEXT | ASN_PRIMITIVE | 0x02)
     95 
     96   typedef struct {
     97     smiUINT32 syntax;
     98     union {
     99       smiINT sNumber;
    100       smiUINT32 uNumber;
    101       smiCNTR64 hNumber;
    102       smiOCTETS string;
    103       smiOID oid;
    104       smiBYTE empty;
    105     } value;
    106   } smiVALUE,*smiLPVALUE;
    107   typedef const smiVALUE *smiLPCVALUE;
    108 
    109 #define MAXOBJIDSIZE 128
    110 #define MAXOBJIDSTRSIZE 1408
    111 
    112 #define SNMP_PDU_GET (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x0)
    113 #define SNMP_PDU_GETNEXT (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x1)
    114 #define SNMP_PDU_RESPONSE (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x2)
    115 #define SNMP_PDU_SET (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x3)
    116 
    117 #define SNMP_PDU_V1TRAP (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x4)
    118 #define SNMP_PDU_GETBULK (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x5)
    119 #define SNMP_PDU_INFORM (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x6)
    120 #define SNMP_PDU_TRAP (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x7)
    121 
    122 #define SNMPLISTEN_USEENTITY_ADDR 0
    123 #define SNMPLISTEN_ALL_ADDR 1
    124 
    125 #define SNMP_TRAP_COLDSTART 0
    126 #define SNMP_TRAP_WARMSTART 1
    127 #define SNMP_TRAP_LINKDOWN 2
    128 #define SNMP_TRAP_LINKUP 3
    129 #define SNMP_TRAP_AUTHFAIL 4
    130 #define SNMP_TRAP_EGPNEIGHBORLOSS 5
    131 #define SNMP_TRAP_ENTERPRISESPECIFIC 6
    132 
    133 #define SNMP_ERROR_NOERROR 0
    134 #define SNMP_ERROR_TOOBIG 1
    135 #define SNMP_ERROR_NOSUCHNAME 2
    136 #define SNMP_ERROR_BADVALUE 3
    137 #define SNMP_ERROR_READONLY 4
    138 #define SNMP_ERROR_GENERR 5
    139 
    140 #define SNMP_ERROR_NOACCESS 6
    141 #define SNMP_ERROR_WRONGTYPE 7
    142 #define SNMP_ERROR_WRONGLENGTH 8
    143 #define SNMP_ERROR_WRONGENCODING 9
    144 #define SNMP_ERROR_WRONGVALUE 10
    145 #define SNMP_ERROR_NOCREATION 11
    146 #define SNMP_ERROR_INCONSISTENTVALUE 12
    147 #define SNMP_ERROR_RESOURCEUNAVAILABLE 13
    148 #define SNMP_ERROR_COMMITFAILED 14
    149 #define SNMP_ERROR_UNDOFAILED 15
    150 #define SNMP_ERROR_AUTHORIZATIONERROR 16
    151 #define SNMP_ERROR_NOTWRITABLE 17
    152 #define SNMP_ERROR_INCONSISTENTNAME 18
    153 
    154 #define SNMPAPI_TRANSLATED 0
    155 #define SNMPAPI_UNTRANSLATED_V1 1
    156 #define SNMPAPI_UNTRANSLATED_V2 2
    157 
    158 #define SNMPAPI_NO_SUPPORT 0
    159 #define SNMPAPI_V1_SUPPORT 1
    160 #define SNMPAPI_V2_SUPPORT 2
    161 #define SNMPAPI_M2M_SUPPORT 3
    162 
    163 #define SNMPAPI_OFF 0
    164 #define SNMPAPI_ON 1
    165 
    166   typedef smiUINT32 SNMPAPI_STATUS;
    167 
    168 #define SNMPAPI_FAILURE 0
    169 #define SNMPAPI_SUCCESS 1
    170 
    171 #define SNMPAPI_ALLOC_ERROR 2
    172 #define SNMPAPI_CONTEXT_INVALID 3
    173 #define SNMPAPI_CONTEXT_UNKNOWN 4
    174 #define SNMPAPI_ENTITY_INVALID 5
    175 #define SNMPAPI_ENTITY_UNKNOWN 6
    176 #define SNMPAPI_INDEX_INVALID 7
    177 #define SNMPAPI_NOOP 8
    178 #define SNMPAPI_OID_INVALID 9
    179 #define SNMPAPI_OPERATION_INVALID 10
    180 #define SNMPAPI_OUTPUT_TRUNCATED 11
    181 #define SNMPAPI_PDU_INVALID 12
    182 #define SNMPAPI_SESSION_INVALID 13
    183 #define SNMPAPI_SYNTAX_INVALID 14
    184 #define SNMPAPI_VBL_INVALID 15
    185 #define SNMPAPI_MODE_INVALID 16
    186 #define SNMPAPI_SIZE_INVALID 17
    187 #define SNMPAPI_NOT_INITIALIZED 18
    188 #define SNMPAPI_MESSAGE_INVALID 19
    189 #define SNMPAPI_HWND_INVALID 20
    190 #define SNMPAPI_OTHER_ERROR 99
    191 
    192 #define SNMPAPI_TL_NOT_INITIALIZED 100
    193 #define SNMPAPI_TL_NOT_SUPPORTED 101
    194 #define SNMPAPI_TL_NOT_AVAILABLE 102
    195 #define SNMPAPI_TL_RESOURCE_ERROR 103
    196 #define SNMPAPI_TL_UNDELIVERABLE 104
    197 #define SNMPAPI_TL_SRC_INVALID 105
    198 #define SNMPAPI_TL_INVALID_PARAM 106
    199 #define SNMPAPI_TL_IN_USE 107
    200 #define SNMPAPI_TL_TIMEOUT 108
    201 #define SNMPAPI_TL_PDU_TOO_BIG 109
    202 #define SNMPAPI_TL_OTHER 199
    203 
    204 #ifndef IN
    205 #define IN
    206 #endif
    207 
    208 #ifndef OUT
    209 #define OUT
    210 #endif
    211 
    212 #define SNMPAPI_CALL WINAPI
    213 
    214 #define MAXVENDORINFO 32
    215 
    216   typedef struct {
    217     char vendorName[MAXVENDORINFO *2];
    218     char vendorContact[MAXVENDORINFO *2];
    219     char vendorVersionId[MAXVENDORINFO];
    220     char vendorVersionDate[MAXVENDORINFO];
    221     smiUINT32 vendorEnterprise;
    222   } smiVENDORINFO,*smiLPVENDORINFO;
    223 
    224   typedef SNMPAPI_STATUS (CALLBACK *SNMPAPI_CALLBACK) (HSNMP_SESSION hSession, HWND hWnd, UINT wMsg, WPARAM wParam, LPARAM lParam, LPVOID lpClientData);
    225 
    226   SNMPAPI_STATUS WINAPI SnmpGetTranslateMode (smiLPUINT32 nTranslateMode);
    227   SNMPAPI_STATUS WINAPI SnmpSetTranslateMode (smiUINT32 nTranslateMode);
    228   SNMPAPI_STATUS WINAPI SnmpGetRetransmitMode (smiLPUINT32 nRetransmitMode);
    229   SNMPAPI_STATUS WINAPI SnmpSetRetransmitMode (smiUINT32 nRetransmitMode);
    230   SNMPAPI_STATUS WINAPI SnmpGetTimeout (HSNMP_ENTITY hEntity, smiLPTIMETICKS nPolicyTimeout, smiLPTIMETICKS nActualTimeout);
    231   SNMPAPI_STATUS WINAPI SnmpSetTimeout (HSNMP_ENTITY hEntity, smiTIMETICKS nPolicyTimeout);
    232   SNMPAPI_STATUS WINAPI SnmpGetRetry (HSNMP_ENTITY hEntity, smiLPUINT32 nPolicyRetry, smiLPUINT32 nActualRetry);
    233   SNMPAPI_STATUS WINAPI SnmpSetRetry (HSNMP_ENTITY hEntity, smiUINT32 nPolicyRetry);
    234   SNMPAPI_STATUS WINAPI SnmpGetVendorInfo (smiLPVENDORINFO vendorInfo);
    235   SNMPAPI_STATUS WINAPI SnmpStartup (smiLPUINT32 nMajorVersion, smiLPUINT32 nMinorVersion, smiLPUINT32 nLevel, smiLPUINT32 nTranslateMode, smiLPUINT32 nRetransmitMode);
    236   SNMPAPI_STATUS WINAPI SnmpCleanup (void);
    237   HSNMP_SESSION WINAPI SnmpOpen (HWND hWnd, UINT wMsg);
    238   SNMPAPI_STATUS WINAPI SnmpClose (HSNMP_SESSION session);
    239   SNMPAPI_STATUS WINAPI SnmpSendMsg (HSNMP_SESSION session, HSNMP_ENTITY srcEntity, HSNMP_ENTITY dstEntity, HSNMP_CONTEXT context, HSNMP_PDU PDU);
    240   SNMPAPI_STATUS WINAPI SnmpRecvMsg (HSNMP_SESSION session, LPHSNMP_ENTITY srcEntity, LPHSNMP_ENTITY dstEntity, LPHSNMP_CONTEXT context, LPHSNMP_PDU PDU);
    241   SNMPAPI_STATUS WINAPI SnmpRegister (HSNMP_SESSION session, HSNMP_ENTITY srcEntity, HSNMP_ENTITY dstEntity, HSNMP_CONTEXT context, smiLPCOID notification, smiUINT32 state);
    242   HSNMP_SESSION WINAPI SnmpCreateSession (HWND hWnd, UINT wMsg, SNMPAPI_CALLBACK fCallBack, LPVOID lpClientData);
    243   SNMPAPI_STATUS WINAPI SnmpListen (HSNMP_ENTITY hEntity, SNMPAPI_STATUS lStatus);
    244   SNMPAPI_STATUS WINAPI SnmpListenEx (HSNMP_ENTITY hEntity, SNMPAPI_STATUS lStatus, smiUINT32 nUseEntityAddr);
    245   SNMPAPI_STATUS WINAPI SnmpCancelMsg (HSNMP_SESSION session, smiINT32 reqId);
    246   SNMPAPI_STATUS WINAPI SnmpStartupEx (smiLPUINT32 nMajorVersion, smiLPUINT32 nMinorVersion, smiLPUINT32 nLevel, smiLPUINT32 nTranslateMode, smiLPUINT32 nRetransmitMode);
    247 
    248   typedef SNMPAPI_STATUS (WINAPI *PFNSNMPSTARTUPEX) (smiLPUINT32, smiLPUINT32, smiLPUINT32, smiLPUINT32, smiLPUINT32);
    249 
    250   SNMPAPI_STATUS WINAPI SnmpCleanupEx (void);
    251 
    252   typedef SNMPAPI_STATUS (WINAPI *PFNSNMPCLEANUPEX) (void);
    253 
    254   HSNMP_ENTITY WINAPI SnmpStrToEntity (HSNMP_SESSION session, LPCSTR string);
    255   SNMPAPI_STATUS WINAPI SnmpEntityToStr (HSNMP_ENTITY entity, smiUINT32 size, LPSTR string);
    256   SNMPAPI_STATUS WINAPI SnmpFreeEntity (HSNMP_ENTITY entity);
    257   HSNMP_CONTEXT WINAPI SnmpStrToContext (HSNMP_SESSION session, smiLPCOCTETS string);
    258   SNMPAPI_STATUS WINAPI SnmpContextToStr (HSNMP_CONTEXT context, smiLPOCTETS string);
    259   SNMPAPI_STATUS WINAPI SnmpFreeContext (HSNMP_CONTEXT context);
    260   SNMPAPI_STATUS WINAPI SnmpSetPort (HSNMP_ENTITY hEntity, UINT nPort);
    261   HSNMP_PDU WINAPI SnmpCreatePdu (HSNMP_SESSION session, smiINT PDU_type, smiINT32 request_id, smiINT error_status, smiINT error_index, HSNMP_VBL varbindlist);
    262   SNMPAPI_STATUS WINAPI SnmpGetPduData (HSNMP_PDU PDU, smiLPINT PDU_type, smiLPINT32 request_id, smiLPINT error_status, smiLPINT error_index, LPHSNMP_VBL varbindlist);
    263   SNMPAPI_STATUS WINAPI SnmpSetPduData (HSNMP_PDU PDU, const smiINT *PDU_type, const smiINT32 *request_id, const smiINT *non_repeaters, const smiINT *max_repetitions, const HSNMP_VBL *varbindlist);
    264   HSNMP_PDU WINAPI SnmpDuplicatePdu (HSNMP_SESSION session, HSNMP_PDU PDU);
    265   SNMPAPI_STATUS WINAPI SnmpFreePdu (HSNMP_PDU PDU);
    266   HSNMP_VBL WINAPI SnmpCreateVbl (HSNMP_SESSION session, smiLPCOID name, smiLPCVALUE value);
    267   HSNMP_VBL WINAPI SnmpDuplicateVbl (HSNMP_SESSION session, HSNMP_VBL vbl);
    268   SNMPAPI_STATUS WINAPI SnmpFreeVbl (HSNMP_VBL vbl);
    269   SNMPAPI_STATUS WINAPI SnmpCountVbl (HSNMP_VBL vbl);
    270   SNMPAPI_STATUS WINAPI SnmpGetVb (HSNMP_VBL vbl, smiUINT32 index, smiLPOID name, smiLPVALUE value);
    271   SNMPAPI_STATUS WINAPI SnmpSetVb (HSNMP_VBL vbl, smiUINT32 index, smiLPCOID name, smiLPCVALUE value);
    272   SNMPAPI_STATUS WINAPI SnmpDeleteVb (HSNMP_VBL vbl, smiUINT32 index);
    273   SNMPAPI_STATUS WINAPI SnmpGetLastError (HSNMP_SESSION session);
    274   SNMPAPI_STATUS WINAPI SnmpStrToOid (LPCSTR string, smiLPOID dstOID);
    275   SNMPAPI_STATUS WINAPI SnmpOidToStr (smiLPCOID srcOID, smiUINT32 size, LPSTR string);
    276   SNMPAPI_STATUS WINAPI SnmpOidCopy (smiLPCOID srcOID, smiLPOID dstOID);
    277   SNMPAPI_STATUS WINAPI SnmpOidCompare (smiLPCOID xOID, smiLPCOID yOID, smiUINT32 maxlen, smiLPINT result);
    278   SNMPAPI_STATUS WINAPI SnmpEncodeMsg (HSNMP_SESSION session, HSNMP_ENTITY srcEntity, HSNMP_ENTITY dstEntity, HSNMP_CONTEXT context, HSNMP_PDU pdu, smiLPOCTETS msgBufDesc);
    279   SNMPAPI_STATUS WINAPI SnmpDecodeMsg (HSNMP_SESSION session, LPHSNMP_ENTITY srcEntity, LPHSNMP_ENTITY dstEntity, LPHSNMP_CONTEXT context, LPHSNMP_PDU pdu, smiLPCOCTETS msgBufDesc);
    280   SNMPAPI_STATUS WINAPI SnmpFreeDescriptor (smiUINT32 syntax, smiLPOPAQUE descriptor);
    281 
    282 #ifdef __cplusplus
    283 }
    284 #endif
    285 
    286 #endif
    287 
    288 #endif
    289