OSRTMsgBufIF.h

Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2003-2017 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  *****************************************************************************/
00028 #ifndef _OSRTMSGBUFIF_H_
00029 #define _OSRTMSGBUFIF_H_
00030 
00031 #include "rtxsrc/OSRTContext.h"
00032 #include "rtxsrc/OSRTCtxtHolderIF.h"
00033 
00034 class OSXMLReaderClass;
00035 
00047 class EXTRTCLASS OSRTMessageBufferIF /*: public OSRTCtxtHolderIF*/ {
00048  public:
00049    enum Type {
00050       BEREncode, BERDecode, PEREncode, PERDecode, XEREncode, XERDecode,
00051       XMLEncode, XMLDecode, JSONEncode, JSONDecode, Stream
00052    } ;
00053  protected:
00058    virtual ~OSRTMessageBufferIF () {}
00059 
00060  public:
00061    // Virtual methods
00065    virtual void* getAppInfo () = 0;
00066 
00073    virtual size_t getByteIndex () = 0;
00074 
00075    virtual OSRTCtxtPtr getContext () = 0;
00076    virtual OSCTXT* getCtxtPtr () = 0;
00077 
00086    virtual OSOCTET* getMsgCopy () = 0;
00087 
00094    virtual const OSOCTET* getMsgPtr () = 0;
00095 
00103    virtual int init () = 0;
00104 
00116    virtual int initBuffer (OSOCTET* pMsgBuf, size_t msgBufLen) = 0;
00117 
00130    virtual OSBOOL isA (Type bufferType) = 0;
00131 
00135    virtual void setAppInfo (void* pAppInfo) = 0;
00136 
00140    virtual void setNamespace
00141       (const OSUTF8CHAR* /*prefix*/, const OSUTF8CHAR* /*uri*/,
00142        OSRTDList* /*pNSAttrs*/ = 0) {}
00143 
00149    virtual void setDiag (OSBOOL value=TRUE) = 0;
00150 
00151 };
00152 
00155 #endif