Classes
backend_access___ backend_access___
The backend access core.
Methods
About Disconnect GetCommand GetCommands GetCommandsIDAndName GetErrorBreakingStatus GetExplanationMessage GetLanguagesIDAndName GetNewObject GetParameters GetType GetTypesIDAndPrefixAndName Init Input Output PopBinaries PopBinary PopBoolean PopByte PopChar PopCommandsDetails PopId16 PopId32 PopId8 PopIds16 PopIds32 PopIds8 PopItems16 PopItems32 PopItems8 PopObject PopObjectsReferences PopString PopStrings PopXItems16 PopXItems32 PopXItems8 PushBinaries PushBinary PushBoolean PushByte PushChar PushCommandsDetails PushHeader PushId16 PushId32 PushId8 PushIds16 PushIds8 PushItems16 PushItems32 PushItems8 PushObject PushObjectsReferences PushString PushStrings PushXItems16 PushXItems32 RemoveObject Send SetErrorBreakingStatus TestCompletion - About : void
- string_ & Name
- string_ & Version
Put in Name and Version the name and version of the backend.
- Disconnect : voidDisconnection.
- GetCommand : command__
- type__ Type
- const string_ & Name
- const ids8_ & Parameters
Return the command of object type Type, named Name with parameter Parameters.
- GetCommands : void
- type__ Type
- const commands_details_ & CommandDetails
- ids16_ & Commands
Put in Commands commands from object of type Type, whith names Names and casts Casts.
- GetCommandsIDAndName : void
- type__ Type
- items16_ & CommandItems
Put in Items the commands name and id of an object of type Type.
- GetErrorBreakingStatus : boolean__Get error breaking status.
- GetExplanationMessage : const char *Return the explnation messag, if any.
- GetLanguagesIDAndName : void
- items16_ & LanguagesItems
Put in Items the language names and ids.
- GetNewObject : object__Return the id of a new object of type Type.
- GetParameters : void
- type__ Type
- command__ Command
- ids8_ & Parameters
Put in Parameters parameters of command Command from object type Type.
- GetType : type__Return the type id. of type TypeName.
- GetTypesIDAndPrefixAndName : voidPut in TypeXItems the types prefix, name and id.
- Init : voidInitialization with Channel to parse/answer the request.
- Input : flw::iflow___ &Return the channel used to handle the request as input flow.
- Output : flw::oflow___ &Return the channel used to handle the request as ouput flow.
- PopBinaries : voidGet Binaries.
- PopBinary : voidGet Binary.
- PopBoolean : voidGet Boolean.
- PopByte : voidGet Byte.
- PopChar : voidGet Char.
- PopCommandsDetails : void
- commands_details_ & CommandsDetails
Get CommandsDetails.
- PopId16 : voidGet Id16.
- PopId32 : voidGet Id32.
- PopId8 : voidGet Id8.
- PopIds16 : voidGet IDs16.
- PopIds32 : voidGet IDs32.
- PopIds8 : voidGet IDs8.
- PopItems16 : voidGet Items16.
- PopItems32 : voidGet Items32.
- PopItems8 : voidGet Items8.
- PopObject : voidGet Object.
- PopObjectsReferences : void
- objects_references_ & ObjectsReferences
Get ObjectsReferences.
- PopString : voidGet String.
- PopStrings : voidGet Strings.
- PopXItems16 : voidGet XItems16.
- PopXItems32 : voidGet XItems32.
- PopXItems8 : voidGet XItems8.
- PushBinaries : void
- const binaries_ & Binaries
Put Binaries.
- PushBinary : voidPut Binary.
- PushBoolean : voidPut Boolean.
- PushByte : voidPut Byte.
- PushChar : voidPut Char.
- PushCommandsDetails : void
- const commands_details_ & CommandsDetails
Put CommandsDetails.
- PushHeader : void
- object__ Object
- command__ Command
Add header with object Object and command Command.
- PushId16 : voidPut Id16.
- PushId32 : voidPut Id32.
- PushId8 : voidPut Id8.
- PushIds16 : voidPut Ids16.
- PushIds8 : voidPut Ids8.
- PushIds8 : voidPut Ids32.
- PushItems16 : voidPut Items16
- PushItems32 : voidPut Items32
- PushItems8 : voidPut Items8
- PushItems8 : voidPut XItems8
- PushObject : voidPut Object.
- PushObjectsReferences : void
- const objects_references_ & ObjectsReferences
Put ObjectsReferences.
- PushString : voidPut String.
- PushStrings : voidPut Strings.
- PushXItems16 : void
- const xitems16_ & XItems16
Put Items16
- PushXItems32 : void
- const xitems32_ & XItems32
Put XItems32
- RemoveObject : voidRemove object Object.
- Send : bso::bool__
- err::handle ERRHandle = err::hUsual
Send the request.
- SetErrorBreakingStatus : boolean__Set error breaking status to B. Return previous error breaking status.
- TestCompletion : voidVerify if all the reponse handled.
Library bkdcmd
BacKenD CoMmanDs.- Version : 1.3
- Release : 2001/10/30 14:49:34
- Coordinators : Claude L. SIMON (csimon@epeios.org)
Defines Defines
BKDCMD_COMMANDS_VERSION - BKDCMD_COMMANDS_VERSION : Version of the commands.
Library bkdcst
BacKenD CaSTs.- Version : 1.2
- Release : 2001/10/30 14:49:34
- Coordinators : Claude L. SIMON (csimon@epeios.org)
Defines Enums Functions Defines
BKDCST_CASTS_VERSION - BKDCST_CASTS_VERSION : Version casts version.
Enums
cast - cast : casts.
- cEnd : End of request or end of parameters list.
- cObject : Object ('bso::ushort__')'.
- cBoolean : Boolean ('bso::bool__')
- cId8 : 8 bits identifier ( bso::ubyte__ ).
- cIds8 : Array of 8 bits identifiers ( SET_( bso::ubyte__ ) )
- cId16 : 16 bits identifier ( bso::ushort__ ).
- cIds16 : Array of 16 bits identifiers ( SET_( bso::ushort__ ) )
- cId32 : 32 bits identifier ('bso::ulong__').
- cIds32 : Array of 32 bits identifiers ( SET_( bso::ulong__ ) )
- cChar : Character ('bso::char__' ).
- cString : String ('str::string_').
- cStrings : Array of strings ( XMCONTAINER_( str::string_ ) )
- cByte : A byte, as data common data cluster for all plateform. Has no intrensec signification ('bso::raw__').
- cBinary : Binary SET_( bso::raw__ ).
- cBinaries : Array of binaries ( XMCONTAINER_( SET_( bso::raw__ ) ) ).
- cItems8 : An array of 8 bits items ( XMCONTAINER_( { bso::ubyte__, str::string_ } ) ).
- cItems16 : An array of 16 bits items ( XMCONTAINER_( { bso::ushort__, str::string_ } ) ).
- cItems32 : An array of 32 bits items ( XMCONTAINER_( { bso::ulong__, str::string_ } ) ).
- cXItems8 : An array of 8 bits extended items ( XMCONTAINER_( { bso::ubyte__, XMCONTAINER_( str::string_ ) } ) ).
- cXItems16 : An array of 16 bits extended items ( XMCONTAINER_( { bso::ubyte__, XMCONTAINER_( str::string_ ) } ) ).
- cXItems32 : An array of 32 bits extended items ( XMCONTAINER_( { bso::ubyte__, XMCONTAINER_( str::string_ ) } ) ).
- cCommandsDetails : Array of command descriptions ( XCONTAINER_( { str::string_, SET_( bso::ubyte__ ) } ) ).
- cObjectsReferences : Array of object types and identifiers. ( SET_( { bso::ushort__, bso::ushort__ } ) ).
- c_amount : Amount of casts.
- cInvalid : Not a cast, but signalize an invalid cast.
Functions
GetID - GetID : castGet id from cast named CastName.
Library bkddcb
BacKenD DesCriBer.- Version : 1.3
- Release : 2001/10/30 14:49:34
- Coordinators : Claude L. SIMON (csimon@epeios.org)
Typedefs Classes Functions Typedefs
commands_ parameter__ parameters_ types_ - commands_ : Broker commands.
- parameter__ : Broker parameter.
- parameters_ : Broker parameters.
- types_ : Broker types.
Classes
command_ type_ command_
A broker Command.
Objects
- command_item_ Identification : The command identification.
- parameters_ Parameters : The parameters.
Methods
Init - Init : voidInitialization.
type_
A broker object type.
Objects
- commands_ Commands : The commands of the type.
- str::string_ Name : Name of the type.
- str::string_ Prefix : Prefix of the type.
Methods
ID Init - ID : type_id__Return the ID.
- ID : voidSet the ID to ID.
- Init : voidInitialization.
Functions
GetDescription - GetDescription : void
- bkdacc::backend_access___ & Backend
- types_ & Types
Fill Types with contents of Backend.
Library bkdmng
BacKenD MaNaGer- Version : 1.3
- Release : 2001/10/30 14:49:34
- Coordinators : Claude L. SIMON (csimon@epeios.org)
Defines Typedefs Classes Defines
BKDMNG_INVALID_COMMAND BKDMNG_INVALID_OBJECT BKDMNG_INVALID_TYPE BKDMNG_RAM_MODULE BKDMNG_STANDARD_MODULE - BKDMNG_INVALID_COMMAND : An invalid value for a command.
- BKDMNG_INVALID_OBJECT : An invalid value for an object.
- BKDMNG_INVALID_TYPE : An invalid value for a type.
- BKDMNG_RAM_MODULE(t) : A ram module of an object of type t.
- BKDMNG_STANDARD_MODULE(t) : A standard module of an object of type t.
Typedefs
list - list : To by-pass a visual C++ bug.
Classes
backend module ram_module standard_module untyped_module backend
A backend, which handles objects od different type and request to this object.
Objects
- links Links : The relation between modules an index.
- bch::E_BUNCH(untyped_module *) Modules : The different modules.
Methods
Add Command ErrorBreaking Handle Init Language Languages Langue Module New Object Remove Type - Add : voidAdd Module to the interface.
- Add : tym::row__
- const char * Name
- function__ FP
- const cast * Casts
Add a request descrption with name Name, function pointer FP and a list of casts Casts. The list must contain 2 cEnd, the first at the end of the parameters casts, and 1 of the end of returned values casts.
- Command : command__
- type__ IdType
- const description_ & Description
Return the command corresponding at request description Description and object type Type. BKDMNG_INVALID_COMMAND is returned if command not found.
- ErrorBreaking : bso::bool__Return the error breaking status.
- ErrorBreaking : voidSet to Value the error breaking status.
- Handle : bso::bool__
- flw::ioflow___ & Channel
- void * PU = NULL
Handle the request which come by Channel and write the answer to Channel. If true is returned, than the request contains a deconnection request.
- Init : void
- const char * Name
- const char * Version
Initialization with Name and Version. Name and Version are NOT duplicated and should not be modified.
- Language : lgg::languageReturn the current language.
- Languages : void
- bso::ushort__ Amount
- const lgg::language * Languages
Tell that Amount language indicated in Languages are supported. Languages is not copied and should NOT be modified.
- Langue : voidLanguage brcomes the current language. Language must, of course' be supported.
- Module : const untyped_module &Give the module for the object of type Type.
- Module : const untyped_module &Give the module for object Object.
- New : object__Give a new object.
- Object : const void *Return a pointer to the Object object.
- Remove : voidRemove object Object.
- Type : type__Give the type of the object Object.
- Type : type__Give the type of a nobject named Name.
module< class t >
A module for an object of type t.
Methods
Init - Init : voidInitialization.
ram_module< class t, class st >
A module with object stored in RAM.
Objects
- bch::E_BUNCH(t *) Objets : The pointer object.
Methods
Init - Init : voidInitialization.
standard_module< class t, class st >
A module with object stored in standard memory.
Objects
- ctn::E_CONTAINER(t) Objets : Contient les objets.
untyped_module
An untyped module.
Objects
- descriptions Descriptions : The description of the request.
- bch::E_BUNCH(const void *) UPs : User pointers.
Methods
Backend Command Handle Init Name New Object Prefix Remove - Backend : backend *Return the backend attached to this module.
- Command : command__
- const description_ & Description
Return the command which has Description as description, or BKDMNG_INVALID_COMMAND if non-existant.
- Handle : void
- index__ Index
- request_manager___ & Requete
- void * UP
Handle the request Request for object of index Index.
- Init : void
- const char * Prefix
- const char * Name
Initialization with the object prefix Prefix and name Name. Prefix and Name are not duplicated. They should NOT be modified.
- Name : const char *Give the name of the object.
- New : index__Give the index of a new object.
- Object : void *Give an pointer to the object of index Index.
- Prefix : const char *Give the prefix of the object.
- Remove : voidRemove the object of index Index.
Handlers
BKDMNGNew BKDMNGObject BKDMNGRemove - BKDMNGNew : index__To get the index of a new object.
- BKDMNGObject : void *To get a pointer of the object of index Index.
- BKDMNGRemove : voidTo remove the object with index Index.
Library bkdrqm
BacKenD ReQuest Manager.- Version : 1.3
- Release : 2001/10/30 14:49:34
- Coordinators : Claude L. SIMON (csimon@epeios.org)
Classes Classes
description_ descriptions_ request_manager___ description_
The description of a request.
Objects
- ids8_ Casts : Parameters and return value types. Separated by cEnd. The cEnd to signalize the end of the request must NOT be put.
- str::string_ Name : Name of the command.
Methods
Add Init - Add : voidAdd Cast.
- Init : voidInitialization. The name ans casts are added one per one.
- Init : void
- const char * Name
- const cast * Casts
Initializing with name Name and a the list of casts Casts. The list must contain 2 cEnd, the first at the end of the parameters casts, and 1 of the end of returned values casts.
- Init : voidInitialization with name Name. The casts would be given using New().
descriptions_
- E_XCONTAINER_( description_ )
Requests descriptions.
Methods
Add Init Position - Add : tym::row__
- const description_ & Description
Adding Description. Return the position where added.
- Add : tym::row__
- const char * Name
- const cast * Casts
See descriptions_::Add() for the descriptions of the parameters. return the position where request description added.
- Init : voidInitialization.
- Position : tym::row__
- const description_ & Description
Return the position of the description Description.
request_manager___
A request manager.
Methods
Complete Init Input Output PopBinaries PopBinary PopBoolean PopByte PopChar PopCommandsDetails PopId16 PopId32 PopId8 PopIds16 PopIds32 PopIds8 PopItems16 PopItems32 PopItems8 PopObject PopObjectsReferences PopString PopStrings PopXItems16 PopXItems32 PopXItems8 PushBinaries PushBinary PushBoolean PushByte PushChar PushCommandsDetails PushId16 PushId32 PushId8 PushIds16 PushIds8 PushItems16 PushItems32 PushItems8 PushObject PushObjectsReferences PushString PushStrings PushXItems16 PushXItems32 PushXItems8 SendExplanationMessage SetDescription - Complete : voidTell that the request is complete (parsed and answered).
- Init : voidInitialization with Channel to parse/answer the request.
- Input : flw::iflow___ &Return the channel used to handle the request as input flow.
- Output : flw::oflow___ &Return the channel used to handle the request as ouput flow.
- PopBinaries : voidGet Binaries.
- PopBinary : voidGet Binary.
- PopBoolean : voidGet Boolean.
- PopByte : voidGet Byte.
- PopChar : voidGet Char.
- PopCommandsDetails : void
- commands_details_ & CommandsDetails
Get CommandsDetails.
- PopId16 : voidGet Id16.
- PopId32 : voidGet Id32.
- PopId8 : voidGet Id8.
- PopIds16 : voidGet IDs16.
- PopIds32 : voidGet IDs32.
- PopIds8 : voidGet IDs8.
- PopItems16 : voidGet Items16.
- PopItems32 : voidGet Items32.
- PopItems8 : voidGet Items8.
- PopObject : voidGet Object.
- PopObjectsReferences : void
- objects_references_ & ObjectsReferences
Get ObjectsReferences.
- PopString : voidGet String.
- PopStrings : voidGet Strings.
- PopXItems16 : voidGet XItems16.
- PopXItems32 : voidGet XItems32.
- PopXItems8 : voidGet XItems8.
- PushBinaries : void
- const binaries_ & Binaries
Put Binaries.
- PushBinary : voidPut Binary.
- PushBoolean : voidPut Boolean.
- PushByte : voidPut Byte.
- PushChar : voidPut Char.
- PushCommandsDetails : void
- const commands_details_ & CommandsDetails
Put CommandsDetails.
- PushId16 : voidPut Id16.
- PushId32 : voidPut Id32.
- PushId8 : voidPut Id8.
- PushIds16 : voidPut Ids16.
- PushIds8 : voidPut Ids8.
- PushIds8 : voidPut Ids32.
- PushItems16 : voidPut Items16
- PushItems32 : voidPut Items32
- PushItems8 : voidPut Items8
- PushObject : voidPut Object.
- PushObjectsReferences : void
- const objects_references_ & ObjectsReferences
Put ObjectsReferences.
- PushString : voidPut String.
- PushStrings : voidPut Strings.
- PushXItems16 : void
- const xitems16_ & XItems16
Put XItems16
- PushXItems32 : void
- const xitems32_ & XItems32
Put XItems32
- PushXItems8 : voidPut XItems8
- SendExplanationMessage : voidSend a message that explain the reason of no treatment.
- SetDescription : void
- const description_ & Description
Description is the description of the request being handled.
Library bkdtpm
PLEASE COMPLETE- Version : 1.2
- Release : 2001/10/30 14:49:34
- Coordinators : Claude L. SIMON (csimon@epeios.org)
Functions Functions
ID Init - ID : idReturn the value of the ID.
- ID : voidID becomes the ID.
- ID : idReturn the value of the ID.
- ID : voidID becomes the ID.
- Init : voidInitialization.
- Init : voidInitialization.
|