Main Page   Modules   Class Hierarchy   Compound List   File List   Compound Members   File Members   Related Pages  

safeBuffer Class Reference
[Internal Classes]

Manage buffers of arbitrary size. More...

#include <XSECSafeBuffer.hpp>

List of all members.

Public Types

enum  bufferType {
  BUFFER_UNKNOWN = 0,
  BUFFER_CHAR = 1,
  BUFFER_UNICODE = 2
}

Public Methods

 safeBuffer ()
 safeBuffer (int initialSize)
 safeBuffer (char *inStr, unsigned int initialSize=DEFAULT_SAFE_BUFFER_SIZE)
 safeBuffer (const safeBuffer &other)
 ~safeBuffer ()
void sbStrcpyIn (const char *inStr)
void sbStrcpyIn (const safeBuffer &inStr)
void sbStrncpyIn (char *inStr, int n)
void sbStrncpyIn (const safeBuffer &inStr, int n)
void sbStrcatIn (char *inStr)
void sbStrcatIn (const safeBuffer &inStr)
void sbStrncatIn (char *inStr, int n)
void sbStrinsIn (const char *inStr, unsigned int offset)
void sbMemcpyIn (void *inBuf, int n)
void sbMemcpyIn (int offset, const void *inBuf, int n)
void sbMemcpyOut (void *outBuf, int n) const
int sbStrncmp (char *inStr, int n)
int sbOffsetStrcmp (char *inStr, unsigned int offset)
int sbOffsetStrncmp (char *inStr, unsigned int offset, int n)
int sbStrcmp (char *inStr) const
int sbStrcmp (const safeBuffer &inStr) const
int sbStrstr (char *inStr)
int sbOffsetStrstr (const char *inStr, unsigned int offset)
unsigned char & operator[] (int n)
safeBuffer & operator= (const safeBuffer &cpy)
int sbStrlen (void) const
unsigned int sbRawBufferSize (void) const
const unsigned char * rawBuffer () const
const char * rawCharBuffer () const
const XMLCh * rawXMLChBuffer () const
void resize (unsigned int sz)
void setBufferType (bufferType bt)
const XMLCh * sbStrToXMLCh (void)
void sbTranscodeIn (const XMLCh *inStr)
void sbTranscodeIn (const char *inStr)
void sbXMLChIn (const XMLCh *in)
void sbXMLChAppendCh (const XMLCh c)
void sbXMLChCat (const XMLCh *str)
void sbXMLChCat (const char *str)

Static Public Methods

void init (void)


Detailed Description

Manage buffers of arbitrary size.

The safeBuffer class is used internally in the library to manage buffers of bytes or UTF-16 characters.

It's a fairly innefficient class, as buffers are continually being wrapped, coppied and enlarged, but given the nature of the library, a single class that manipulates buffers of variable size was felt to be preferable,

The safeBuffer is not exposed through interface classes that might be used by external functions. In these cases, a pointer to a XMLCh * buffer is used by preference.


Member Enumeration Documentation

enum safeBuffer::bufferType
 

Enumeration values:
BUFFER_UNKNOWN 
BUFFER_CHAR 
BUFFER_UNICODE 


Constructor & Destructor Documentation

safeBuffer::safeBuffer  
 

safeBuffer::safeBuffer int    initialSize
 

safeBuffer::safeBuffer char *    inStr,
unsigned int    initialSize = DEFAULT_SAFE_BUFFER_SIZE
 

safeBuffer::safeBuffer const safeBuffer &    other
 

safeBuffer::~safeBuffer  
 


Member Function Documentation

void safeBuffer::init void    [static]
 

safeBuffer& safeBuffer::operator= const safeBuffer &    cpy
 

unsigned char& safeBuffer::operator[] int    n
 

const unsigned char* safeBuffer::rawBuffer   const
 

const char* safeBuffer::rawCharBuffer   const
 

const XMLCh* safeBuffer::rawXMLChBuffer   const
 

void safeBuffer::resize unsigned int    sz
 

void safeBuffer::sbMemcpyIn int    offset,
const void *    inBuf,
int    n
 

void safeBuffer::sbMemcpyIn void *    inBuf,
int    n
 

void safeBuffer::sbMemcpyOut void *    outBuf,
int    n
const
 

int safeBuffer::sbOffsetStrcmp char *    inStr,
unsigned int    offset
 

int safeBuffer::sbOffsetStrncmp char *    inStr,
unsigned int    offset,
int    n
 

int safeBuffer::sbOffsetStrstr const char *    inStr,
unsigned int    offset
 

unsigned int safeBuffer::sbRawBufferSize void    const
 

void safeBuffer::sbStrcatIn const safeBuffer &    inStr
 

void safeBuffer::sbStrcatIn char *    inStr
 

int safeBuffer::sbStrcmp const safeBuffer &    inStr const
 

int safeBuffer::sbStrcmp char *    inStr const
 

void safeBuffer::sbStrcpyIn const safeBuffer &    inStr
 

void safeBuffer::sbStrcpyIn const char *    inStr
 

void safeBuffer::sbStrinsIn const char *    inStr,
unsigned int    offset
 

int safeBuffer::sbStrlen void    const
 

void safeBuffer::sbStrncatIn char *    inStr,
int    n
 

int safeBuffer::sbStrncmp char *    inStr,
int    n
 

void safeBuffer::sbStrncpyIn const safeBuffer &    inStr,
int    n
 

void safeBuffer::sbStrncpyIn char *    inStr,
int    n
 

int safeBuffer::sbStrstr char *    inStr
 

const XMLCh* safeBuffer::sbStrToXMLCh void   
 

void safeBuffer::sbTranscodeIn const char *    inStr
 

void safeBuffer::sbTranscodeIn const XMLCh *    inStr
 

void safeBuffer::sbXMLChAppendCh const XMLCh    c
 

void safeBuffer::sbXMLChCat const char *    str
 

void safeBuffer::sbXMLChCat const XMLCh *    str
 

void safeBuffer::sbXMLChIn const XMLCh *    in
 

void safeBuffer::setBufferType bufferType    bt
 


The documentation for this class was generated from the following file:
Generated on Wed Mar 26 20:12:16 2003 for XML-Security-C by doxygen1.2.15