C/C++ Reference
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
_EhSendData
AllocatorIntfMemory allocation and deallocation Interface class
AuthenticatedUserAbstract base class implemented by BasicAuthUser, FormAuthUser and DigestAuthUser
AuthenticatorThis class implements HTTP Basic, HTTP Digest, and Form-Based Authentication
AuthenticatorIntfAbstract interface class implemented by DigestAuthenticator, FormAuthenticator and DigestAuthenticator
AuthInfoAn instance of the AuthInfo struct is created on the stack in the Barracuda authenticators and is used as a container object for sending information to the registered user callback methods
AuthorizerIntfAn abstract class, which you must implement, provides a method of authorizing an authenticated user
BaLua_paramThe startup and runtime parameters for a Barracuda Server Lua VM
BasicAuthenticatorImplements Basic Authentication
BaTimerThe timer class makes it possible to create events that are activated at regular intervals or to create events that are activated only one time
BaTmRepresents the components of calendar time
BufPrintThe BufPrint class, which implements an ANSI compatible printf method, is an abstract class used as a base for many of the Barracuda classes
ClientConnectionClass to use by a Client for communicating over a TCP Socket
CspReaderAbstract interface class for reading the "dat" file generated byHttpLink
DavAuthThis class implements HTTP Basic and HTTP Digest authentication
DefaultMqThe default message queue is a simple implementation of the abstract interface MqInterf
DigestAuthenticatorImplements Digest Authentication
DirIntfDirectory handle for a directory opened with IoIntf_OpenDir
DiskIoMakes it possible for the web-server to work with resources on a hard drive
DynBufferA dynamic buffer
EhConListenerSubclass this class if you want to be notified when a new client connects or a client connection terminates
EhDirThe EventHandler container class
EhInterfaceThe EhInterface callback interface contains one or several EhMethods -- i.e., the methods being called by an EventHandler client
EhMethodEhMethod is the callback function used by EhInterface
EventHandlerEventHandler bi-directional asynchronous communication stack
EventHandlerConfigUse an instance of this class if you would like to override the default EventHandler configuration parameters
FileCspReaderExample code that shows you how to write a CspReader driver object
FileZipReaderExample code that shows you how to write a ZipReader interface for the ZipIo class
FixedSizeAllocatorThis is a fixed size allocator implementation for the abstract interface class AllocatorIntf
FormAuthenticatorImplements Form-Based Authentication
HttpAsynchReqAsynchronously receive data in a resource such as HttpDir or HttpPage
HttpAsynchReqRespSimultaneously receive and send a stream of data
HttpAsynchRespSend data asynchronously to a client
HttpClientThe HTTP(S) "C" client library implementation conforms to the HTTP/1.1 standard, RFC 2616
HttpClientHeaderThe response HTTP headers returned by HttpClient::getHeaders
HttpClientKeyValA container for key/value pairs that is used when setting custom HTTP headers and/or when setting URL encoded HTTP parameters
HttpCmdThreadPoolAn instance of this class provides a thread pool to an instance of the HttpServer class
HttpCommandContainer class for the HttpRequest and HttpResponse command pair
HttpConnectionContains information about the physical socket connection
HttpCookieA cookie is used for exchanging a small amount of information between a HttpPage and a web browser
HttpDirAn instance of the HttpDir class, which is a collection of zero or more resources, serves as one directory entry in the virtual file system
HttpInDataThe web-server "Request Data" container
HttpMuxDirHttpMuxDir HttpDir Multiplexer captures many muxResource requests and feeds all muxResource requests to one page
HttpPageAn HttpPage, which is typically created by the CSP compiler, is similar to a Java servlet
HttpParameterA persistent container object for HTTP parameters
HttpParameterIteratorThe HttpParameterIterator is used for iterating through the form elements parsed by the HttpServer object
HttpRdFilterSuperclass for HttpResRdr filters
HttpRecDataMakes it easy to upload packets or large data chunks when using Barracuda in multithread mode
HttpRequestThe HttpServer creates an HttpRequest object when the HttpServer parses a client request
HttpResMgrMakes it possible for HTTP clients to use an IoIntf for uploading and downloading files
HttpResponseThis object is used when sending response messages back to the client
HttpResRdrThe HTTP resource reader searches and presents IoIntf resources to HTTP clients requesting such information
HttpServConCreate a server listen object
HttpServerThe Web Server
HttpServerConfigUse an instance of this class if you want to override the default web-server parameters
HttpServerPipeA HttpPipe can be used to establish connections similar to a TCP socket connection between clients and the server
HttpSessionProvides a way to identify a user across more than one page request or visit to a web site, and to store information about that user
HttpSessionAttributeThe interface to an HttpSession attribute
HttpSessionContainerThe HttpSession container class
HttpSharkSslServConCreate a SharkSSL server listen object
HttpStdHeadersStandard HTTP header values
HttpTraceTrace the communication between a client and the server
HttpTraceWriteLockHttpTraceWriteLock is a C++ class that makes it easier to lock the trace by using method HttpTrace::getWriter and HttpTrace::releaseWriter
HttpUploadThe HttpUpload node is responsible for creating and starting HttpUploadNode instances
HttpUploadCbIntfThe HttpUploadCbIntf interface is an abstract class that must be implemented by code using the HttpUpload
HttpUploadNodeA HttpUploadNode is dynamically created by an HttpUpload instance for each concurrent upload
IoIntfAbstract file API, implementations include ZipIo, DiskIo, and NetIo
IoIntfCspReaderThe IoIntfCspReader, which implements the abstract CspReader interface, makes it possible to open a "CSP dat" file via a IoIntf
IoIntfZipReaderThe IoIntfZipReader, which implements the abstract ZipReader interface, makes it possible for a ZipIo to open a ZIP file via another IoInterface
IoStatResource information
JErrThe JSON error container object
JParserThe Barracuda JSON parser is unique in that it is designed for parsing data coming from a stream such as a TCP/IP connection, a pipe, etc
JParserIntfThe JParserIntf interface class is the interface between the parser and an object that implements the JParserIntf interface
JParserValFactJParserValFact is the JVal JSON parser factory class
JRpcAn instance of the JRpc class is a JSON-RPC web-service
JRpcMethodJRpcMethod is the callback function used by JRpcObj
JRpcObjThe JSON-RPC callback object contains one or several JRpcMethods; the methods being called by a JSON-RPC client
JRpcPageJRpcPage is the interface between the Barracuda Virtual File System and JRpc
JRpcRespJRpcResp is responsible for sending a response to a JSON-RPC request
JSerializerThe JSerializer can serialize a JSON JVAL syntax tree to the JSON text format
JValJVal represents a value in a JSON tree
JValFactThe JValFact enables one to manually create a JVal syntax tree or add nodes to an existing syntax tree
LHttpDir
LockEventHandlerA C++ way of locking the Barracuda web-server
LoginRespIntfThe LoginRespIntf is an abstract class, which must be implemented when using one of DigestAuthenticator, BasicAuthenticator, and FormAuthenticator
LoginTrackerOptional security enhancement that can be installed in an instance of one of the authenticator classes
LoginTrackerIntfThe interface between the LoginTracker and the application code
LoginTrackerNodeA LoginTrackerNode keeps track of how many times a user using a specific IP address has attempted to login to the server
MqInterfMqInterf is an implementation independent message queue
MqMessageThe abstract class MqMessage is the only message that can be sent using the MqInterf
MultipartUploadThe MultipartUpload, which is an abstract base class, implements the functionality as specified in RFC 1867
NetIoThe NetIo is similar to a network file system and makes it possible for the server to access resources on another Barracuda server
ResIntfResource handle for a directory opened with IoIntf_OpenRes
SoDispThe SoDisp dispatches any socket connection that contains data by calling the SoDispCon::execute member function in a SoDispCon object
SoDispConContains information about the physical socket connection
SoDispCon_GetCertificate
ThreadA simple thread class
ThreadLockThis class provides an easy and less error prone way of locking and releasing a mutex
ThreadMutexA mutual exclusion class
ThreadReleaseLockThis class provides an easy and less error prone way of temporarily releasing a locked mutex
ThreadSemaphoreA simple semaphore implementation
UserIntfInterface class used by the Authentication classes
WebDAVThe WebDAV plugin implements WebDAV version 1, as specified in RFC2518 and part of the locking in DAV 2, making it interoperate with "drive" clients requiring locking
WebDAVLockMgr
WnmpDirThe WNMP directory class
WnmpFieldThe WNMP field class
WnmpFieldDefinitionThe WNMP field definition class
WnmpFieldIteratorThe WNMP field iterator class
WnmpModuleThe WNMP module class
WnmpValueThe WNMP value type
ZipContainerA ZipContainer is a buffer used by a ZipIo when reading data from a ZipReader
ZipIoMakes it possible for the web-server to work with resources in a ZIP file as if the ZIP file is a read-only file system
ZipReaderAbstract interface class for reading a ZipFile
ZzEhSend