Carapace

Comms Configuration

Comms configuration is held in the system registry under the hive 

    HKEY_CURRENT_USER
in the section: 
    Software/Carapace/Communications
This contains the following sub-sections:

Services lists services and information about how to connect to them
Stacks lists comms stacks and their configuration information
Modules lists comms modules and information about them

Comms Services

Each sub-section within this 'Services' section is the name of a service to connect to. For example, the sub-section called MasterMailer could link you to you company's central mail hub.

To see what configuration is required for a service, click here.

Comms Stacks

Each sub-section within this 'Stacks' section is the name of a communications stack. For example, if you connect to many different mail hubs each of which talks SMTP over TCP/IP, then you could have an 'Smtp' subsection which defines the following stack of modules: 

    Smtp,Util,Tcp
In addition, since all the mailers use TCP port 25, it would also set this attribute.

To see what configuration is required for a stack, click here.

Comms Modules

Each sub-section within this 'Modules' section is the name of a support comms module. The module's sub-section contains the following attributes:

library name of the dynamic library to load which supports the module -- not required for scripted modules
script name of the Carapace script to load which supports the module -- only required for scripted modules

In addition, for each property of the module there is a string attribute whose name is that of the property, and whose value is the type of the property.

For example, the Tcp module supports host and port properties, so the section describing the Tcp module is called Tcp and contains the following string attributes: 

    host="String"
    port="Integer"
Note: Since Carapace is case-sensitive, the name of the attribute must be exactly the same as the supported property. Similarly, the values must be exactly the same as a class within Carapace.

Contents Index Current topic: communications Related topics: communications classes, objects