rtxMemBuf.h

Go to the documentation of this file.

/*
 * Copyright (c) 2003-2022 Objective Systems, Inc.
 *
 * This software is furnished under a license and may be used and copied
 * only in accordance with the terms of such license and with the
 * inclusion of the above copyright notice. This software or any other
 * copies thereof may not be provided or otherwise made available to any
 * other person. No title to and ownership of the software is hereby
 * transferred.
 *
 * The information in this software is subject to change without notice
 * and should not be construed as a commitment by Objective Systems, Inc.
 *
 * PROPRIETARY NOTICE
 *
 * This software is an unpublished work subject to a confidentiality agreement
 * and is protected by copyright and trade secret law.  Unauthorized copying,
 * redistribution or other use of this work is prohibited.
 *
 * The above notice of copyright on this source code product does not indicate
 * any actual or intended publication of such source code.
 *
 *****************************************************************************/

/* memory buffer */

#ifndef _RTXMEMBUF_H_
#define _RTXMEMBUF_H_

#include "rtxsrc/rtxContext.h"

typedef struct OSRTMEMBUF {
   OSCTXT*      pctxt;
   OSSIZE       segsize;        /* segment size                     */
   OSSIZE       startidx;       /* start index of useful info       */
   OSSIZE       usedcnt;        /* used byte count                  */
   OSSIZE       bufsize;        /* buffer size                      */
   OSSIZE       bitOffset;      /* bit offset                       */
   OSUINT32     userState;      /* user state - any value, 0 is initial */
   OSOCTET*     buffer;         /* memory buffer                    */
   OSBOOL       isDynamic;      /* is buffer allocated dynamically? */
   OSBOOL       isExpandable;   /* is buffer expandable?            */
   OSBOOL       useSysMem;      /* use system memory management     */
} OSRTMEMBUF;

#define OSMBDFLTSEGSIZE 1024

#define OSMEMBUFPTR(pmb)    ((pmb)->buffer + (pmb)->startidx)
#define OSMEMBUFENDPTR(pmb) ((pmb)->buffer + (pmb)->startidx + (pmb)->usedcnt)
#define OSMEMBUFUSEDSIZE(pmb) ((OSSIZE)(pmb)->usedcnt)

/* These macros do not null-terminate the appended string */
#define OSMBAPPENDSTR(pmb,str) if (0 != str) \
rtxMemBufAppend(pmb,(OSOCTET*)str,OSCRTLSTRLEN(str))

#define OSMBAPPENDSTRL(pmb,str) \
rtxMemBufAppend(pmb,(OSOCTET*)str,OSCRTLSTRLEN(str))

#define OSMBAPPENDUTF8(pmb,str) if (0 != str) \
rtxMemBufAppend(pmb,(OSOCTET*)str,rtxUTF8LenBytes(str))

/* This macro will null-terminate the appended string */
#define OSMBAPPENDSTRZ(pmb,str) \
rtxMemBufAppend(pmb,(OSOCTET*)str,OSCRTLSTRLEN(str)+1)

#ifdef __cplusplus
extern "C" {
#endif

/* Memory buffer functions */

EXTERNRT int rtxMemBufAppend
(OSRTMEMBUF* pMemBuf, const OSOCTET* pdata, OSSIZE nbytes);

EXTERNRT int rtxMemBufCut
(OSRTMEMBUF* pMemBuf, OSSIZE fromOffset, OSSIZE nbytes);

EXTERNRT void rtxMemBufFree (OSRTMEMBUF* pMemBuf);

EXTERNRT OSOCTET* rtxMemBufGetData (const OSRTMEMBUF* pMemBuf, int* length);

EXTERNRT OSOCTET* rtxMemBufGetDataExt
(const OSRTMEMBUF* pMemBuf, OSSIZE* length);

EXTERNRT OSSIZE rtxMemBufGetDataLen (const OSRTMEMBUF* pMemBuf);

EXTERNRT void rtxMemBufInit
(OSCTXT* pCtxt, OSRTMEMBUF* pMemBuf, OSSIZE segsize);

EXTERNRT void rtxMemBufInitBuffer (OSCTXT* pCtxt, OSRTMEMBUF* pMemBuf,
                                    OSOCTET* buf, OSSIZE bufsize,
                                    OSSIZE segsize);

EXTERNRT int rtxMemBufPreAllocate (OSRTMEMBUF* pMemBuf, OSSIZE nbytes);

EXTERNRT void rtxMemBufReset (OSRTMEMBUF* pMemBuf);

EXTERNRT int rtxMemBufSet (OSRTMEMBUF* pMemBuf, OSOCTET value, OSSIZE nbytes);

EXTERNRT OSBOOL rtxMemBufSetExpandable
(OSRTMEMBUF* pMemBuf, OSBOOL isExpandable);

EXTERNRT OSBOOL rtxMemBufSetUseSysMem (OSRTMEMBUF* pMemBuf, OSBOOL value);

EXTERNRT OSSIZE rtxMemBufTrimW (OSRTMEMBUF* pMemBuf);

#ifdef __cplusplus
}
#endif

#endif