asn1BerCppTypes.h

Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 1997-2012 Objective Systems, Inc.
00003  *
00004  * This software is furnished under a license and may be used and copied
00005  * only in accordance with the terms of such license and with the
00006  * inclusion of the above copyright notice. This software or any other
00007  * copies thereof may not be provided or otherwise made available to any
00008  * other person. No title to and ownership of the software is hereby
00009  * transferred.
00010  *
00011  * The information in this software is subject to change without notice
00012  * and should not be construed as a commitment by Objective Systems, Inc.
00013  *
00014  * PROPRIETARY NOTICE
00015  *
00016  * This software is an unpublished work subject to a confidentiality agreement
00017  * and is protected by copyright and trade secret law.  Unauthorized copying,
00018  * redistribution or other use of this work is prohibited.
00019  *
00020  * The above notice of copyright on this source code product does not indicate
00021  * any actual or intended publication of such source code.
00022  *
00023  *****************************************************************************/
00024 //
00025 // CHANGE LOG
00026 // Date         Init    Description
00027 // 07/14/02     ED      Changed all methods to being with lowercase
00028 //                      char for consistency.  Added deprecated inline
00029 //                      methods for those that did not to maintain
00030 //                      backward compatibility.
00031 // 10/30/03     CZ      Added Doxygen code.
00032 //
00034 
00039 #ifndef _ASN1BERCPPTYPES_H_
00040 #define _ASN1BERCPPTYPES_H_
00041 
00042 #include "rtsrc/asn1CppTypes.h"
00043 #include "rtbersrc/asn1ber.h"
00044 #include "rtxsrc/rtxPrint.h"
00045 
00057 // ASN.1 BER message buffer class
00058 
00068 class EXTERNBER ASN1BERMessageBuffer : public ASN1MessageBuffer {
00069  protected:
00078    ASN1BERMessageBuffer (Type bufferType) : ASN1MessageBuffer(bufferType) {}
00079 
00091    ASN1BERMessageBuffer (Type bufferType, OSRTContext *pContext) :
00092       ASN1MessageBuffer (bufferType, pContext) { }
00093 
00094  public:
00110    inline int calcIndefLen (OSOCTET* buf_p, int bufSize = INT_MAX) {
00111       return xd_indeflen_ex (buf_p, bufSize);
00112    }
00113 
00124    inline void binDump () {
00125       int stat = xu_dump ((OSOCTET*)getMsgPtr(), 0, 0);
00126       if (stat != 0) setStatus (stat);
00127    }
00128 
00139    inline void hexDump (int numocts) {
00140       rtxHexDump (getMsgPtr(), numocts);
00141    }
00142 
00143    // deprecated methods
00144    inline int  CalcIndefLen (OSOCTET* buf_p) { return calcIndefLen(buf_p); }
00145    inline void BinDump () { binDump(); }
00146    inline void HexDump (int numocts) { hexDump (numocts); }
00147 } ;
00148 
00149 // ASN.1 BER encode message buffer class
00156 class EXTERNBER ASN1BEREncodeBuffer : public ASN1BERMessageBuffer {
00157  public:
00163    ASN1BEREncodeBuffer ();
00164 
00174    ASN1BEREncodeBuffer (OSOCTET* pMsgBuf, size_t msgBufLen);
00175 
00187    ASN1BEREncodeBuffer
00188       (OSOCTET* pMsgBuf, size_t msgBufLen, OSRTContext* pContext);
00189 
00194    inline void freeBuffer() { xe_free (getCtxtPtr()); }
00195 
00211    virtual OSOCTET* getMsgCopy ();
00212 
00223    virtual const OSOCTET* getMsgPtr ();
00224 
00242    int init ();
00243 
00253    virtual OSBOOL isA (int bufferType) {
00254       return bufferType == BEREncode;
00255    }
00256 
00274    int setBuffer (OSOCTET* pMsgBuf, size_t msgBufLen);
00275 
00281    ASN1BEREncodeBuffer& operator << (ASN1CType& val);
00282 } ;
00283 
00284 
00285 // ASN.1 BER decode message buffer class
00293 class EXTERNBER ASN1BERDecodeBuffer : public ASN1BERMessageBuffer {
00294  protected:
00295    const OSOCTET* mpMsgBuf;
00296    size_t mMsgBufLen;
00297    OSBOOL mBufSetFlag;
00298 
00299  public:
00304    ASN1BERDecodeBuffer ();
00305 
00322    ASN1BERDecodeBuffer (const OSOCTET* pMsgBuf, size_t msgBufLen);
00323 
00341    ASN1BERDecodeBuffer
00342       (const OSOCTET* pMsgBuf, size_t msgBufLen, OSRTContext* pContext);
00343 
00366    OSOCTET* findElement
00367       (ASN1TAG tag, OSINT32& elemLen, OSBOOL firstFlag = TRUE);
00368 
00375    virtual const OSOCTET* getMsgPtr() {
00376       // Note: return message buffer pointer from object, not from context,
00377       // because may not yet be set in context (ED, 9/30/04)..
00378       return mpMsgBuf;
00379    }
00380 
00388    int init ();
00389 
00399    virtual OSBOOL isA (int bufferType) {
00400       return bufferType == BERDecode;
00401    }
00421    inline int parseTagLen (ASN1TAG& tag, int& msglen) {
00422       mBufSetFlag = TRUE;
00423       return xd_setp (getCtxtPtr(),
00424                       mpMsgBuf, (int)mMsgBufLen, &tag, &msglen);
00425    }
00426 
00437    int readBinaryFile (const char* filePath);
00438 
00450    int setBuffer (const OSOCTET* pMsgBuf, size_t msgBufLen);
00451 
00452    // deprecated methods
00453    inline OSOCTET* FindElement (ASN1TAG tag, int& elemLen,
00454                                 int firstFlag = 1) {
00455       return findElement (tag, elemLen, (OSBOOL)firstFlag);
00456    }
00457    inline int ParseTagLen (ASN1TAG& tag, int& msglen) {
00458       return parseTagLen (tag, msglen);
00459    }
00460 
00466    ASN1BERDecodeBuffer& operator >> (ASN1CType& val);
00467 } ;
00468 
00476 #endif