Barracuda Application Server C/C++ Reference
Native APIs, integration guides, and platform interfaces
IoIntfCspReader.h File Reference
#include <CspRunTm.h>
#include <IoIntf.h>
Include dependency graph for IoIntfCspReader.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  IoIntfCspReader
 The IoIntfCspReader, which implements the abstract CspReader interface, makes it possible to open a "CSP dat" file via a IoIntf. More...
 

Macros

#define IoIntfCspReader_destructor(o)   IoIntfCspReader_close(o);
 Close without freeing the object itself. More...
 

Typedefs

typedef IoIntfCspReader IoIntfCspReader
 The IoIntfCspReader, which implements the abstract CspReader interface, makes it possible to open a "CSP dat" file via a IoIntf. More...
 

Functions

BA_API void IoIntfCspReader_constructor (IoIntfCspReader *o, IoIntf *io, const char *pathName)
 Initialize a CSP data reader; see IoIntfCspReader::IoIntfCspReader. More...
 
BA_API int IoIntfCspReader_close (IoIntfCspReader *o)
 Close the reader after all its users have stopped. More...
 

Macro Definition Documentation

◆ IoIntfCspReader_destructor

#define IoIntfCspReader_destructor (   o)    IoIntfCspReader_close(o);

Close without freeing the object itself.

Parameters
[in,out]oInitialized reader whose users have stopped. The C++ destructor discards the close status.

Function Documentation

◆ IoIntfCspReader_close()

BA_API int IoIntfCspReader_close ( IoIntfCspReader o)

Close the reader after all its users have stopped.

Parameters
[in,out]oInitialized reader; no further reads are allowed.
Returns
Zero success, underlying negative close error, or -1 if not open. See IoIntfCspReader::close.

◆ IoIntfCspReader_constructor()

BA_API void IoIntfCspReader_constructor ( IoIntfCspReader o,
IoIntf io,
const char *  pathName 
)

Initialize a CSP data reader; see IoIntfCspReader::IoIntfCspReader.

Parameters
[out]oCaller-owned object to initialize.
[in]ioBorrowed seekable I/O interface, valid until close.
[in]pathNameRequired NUL-terminated CSP data path within io. Check CspReader_isValid before use.