simplebuf.c File Reference

Simple [io] buffer declarations and operations. More...

#include <unistd.h>
#include "rnr/rnrconfig.h"
#include "rnr/new.h"
#include "rnr/simplebuf.h"

Go to the source code of this file.

Functions
SimpleBuf_T *	SimpleBufNew ()
	Allocate a new simple buffer with no internal buffer allocation. More...
SimpleBuf_T *	SimpleBufNewWithBuf (size_t nBufSize)
	Allocate a new simple buffer with internal buffer of nBufSize. More...
void	SimpleBufDelete (SimpleBuf_T *pBuf)
	Delete a simple buffer along with the internal buffer. More...
void	SimpleBufSetBuf (SimpleBuf_T *pBuf, byte_t *pRWBuf, size_t nBufSize, size_t nLen)
	Set simple buffer's internal read/write buffer. More...
size_t	SimpleBufCopy (SimpleBuf_T *pTgt, SimpleBuf_T *pSrc)
	Copy contents of source simple buffer to the end of the target simple buffer. More...

Detailed Description

Simple [io] buffer declarations and operations.

LastChangedDate

2010-03-24 10:19:36 -0600 (Wed, 24 Mar 2010)

Rev

307

The buffer is orgainized as a simple linear buffer with independent read and write positions. Ideal for multi-tasking.

Author

Robin Knight (robin.nosp@m..kni.nosp@m.ght@r.nosp@m.oadn.nosp@m.arrow.nosp@m.s.co.nosp@m.m)

Copyright

© 2005-2018. RoadNarrows LLC..
http://www.roadnarrows.com
All Rights Reserved

Definition in file simplebuf.c.

Function Documentation

size_t SimpleBufCopy	(	SimpleBuf_T *	pTgt,
		SimpleBuf_T *	pSrc
	)

Copy contents of source simple buffer to the end of the target simple buffer.

Parameters

pTgt	Pointer to target simple buffer.
pSrc	Pointer to source simple buffer.

Return Value:

Returns

Returns Number of bytes copied.

Definition at line 165 of file simplebuf.c.

References SimpleBuf_T::m_nBufSize, SimpleBuf_T::m_nRPos, SimpleBuf_T::m_nWPos, SimpleBuf_T::m_pRWBuf, and NULL.

{
  size_t  rpos, nBytes;

  if( (pTgt == NULL) || (pSrc == NULL) )
  {
    return (size_t)0;
  }

  for(rpos=pSrc->m_nRPos, nBytes=0;
      (rpos < pSrc->m_nWPos) && (pTgt->m_nWPos < pSrc->m_nBufSize);
      ++rpos, ++nBytes)
  {
    pTgt->m_pRWBuf[pTgt->m_nWPos++] = pSrc->m_pRWBuf[rpos];
  }

  return nBytes;
}

void SimpleBufDelete

(

SimpleBuf_T *

pBuf

)

Delete a simple buffer along with the internal buffer.

Actual deletion on occurs if buffer is owned by this simple buffer.

Parameters

pBuf	Pointer to simple buffer to be deleted.

Definition at line 111 of file simplebuf.c.

References SimpleBuf_T::m_bBufDel, SimpleBuf_T::m_pRWBuf, and NULL.

Referenced by SocketBufNewBuf(), and SocketDelete().

{
  if( pBuf == NULL )
  {
    return;
  }

  if( pBuf->m_bBufDel )
  {
    delete(pBuf->m_pRWBuf);
  }
  delete(pBuf);
}

SimpleBuf_T* SimpleBufNew

(

)

Allocate a new simple buffer with no internal buffer allocation.

Returns

Returns SimpleBuf_T* to newly allocated simple buffer.

Definition at line 70 of file simplebuf.c.

References SimpleBuf_T::m_bBufDel, SimpleBuf_T::m_nBufSize, SimpleBuf_T::m_nRPos, SimpleBuf_T::m_nWPos, SimpleBuf_T::m_pRWBuf, NEW, and NULL.

Referenced by SocketNew().

{
  SimpleBuf_T *pBuf = NEW(SimpleBuf_T);

  pBuf->m_pRWBuf    = NULL;
  pBuf->m_nBufSize  = (size_t)0;
  pBuf->m_nRPos     = (size_t)0;
  pBuf->m_nWPos     = (size_t)0;
  pBuf->m_bBufDel   = false;

  return pBuf;
}

SimpleBuf_T* SimpleBufNewWithBuf

(

size_t

nBufSize

)

Allocate a new simple buffer with internal buffer of nBufSize.

Parameters

nBufSize

Size in bytes of internal buffer to allocate with simple buffer.

Returns

Returns SimpleBuf_T* to newly allocated simple buffer.

Definition at line 91 of file simplebuf.c.

References SimpleBuf_T::m_bBufDel, SimpleBuf_T::m_nBufSize, SimpleBuf_T::m_nRPos, SimpleBuf_T::m_nWPos, SimpleBuf_T::m_pRWBuf, and NEW.

Referenced by SocketBufNewBuf().

{
  SimpleBuf_T *pBuf = NEW(SimpleBuf_T);

  pBuf->m_pRWBuf    = (byte_t *)new(nBufSize);
  pBuf->m_nBufSize  = nBufSize;
  pBuf->m_nRPos     = (size_t)0;
  pBuf->m_nWPos     = (size_t)0;
  pBuf->m_bBufDel   = true;

  return pBuf;
}

void SimpleBufSetBuf	(	SimpleBuf_T *	pBuf,
		byte_t *	pRWBuf,
		size_t	nBufSize,
		size_t	nLen
	)

Set simple buffer's internal read/write buffer.

Parameters

pBuf	Pointer to simple buffer.
pRWBuf	Pointer to buffer to be set as the internal read/write buffer.
nBufSize	Size in bytes of pRWBuf.
nLen	Current length (bytes) of data in pRWBuf.

Definition at line 134 of file simplebuf.c.

References SimpleBuf_T::m_bBufDel, SimpleBuf_T::m_nBufSize, SimpleBuf_T::m_nRPos, SimpleBuf_T::m_nWPos, SimpleBuf_T::m_pRWBuf, and NULL.

Referenced by SocketBufSetBuf().

{
  if( pBuf == NULL )
  {
    return;
  }

  if( pBuf->m_bBufDel )
  {
    delete(pBuf->m_pRWBuf);
  }
 
  pBuf->m_pRWBuf    = pRWBuf;
  pBuf->m_nBufSize  = nBufSize;
  pBuf->m_nRPos     = (size_t)0;
  pBuf->m_nWPos     = nLen<=nBufSize? nLen: nBufSize;
  pBuf->m_bBufDel   = false;
}