The Robot Application Function Header Files

This section discusses the header files needed for creating robot application functions. The following topics are described:

• Header File Hierarchy

• Header File Contents

Header File Hierarchy

The hierarchy of robot plug-in API header files is (directories are shown in bold):

robot
    include
        cscinfo.h
        csmem.h
        filterrules.h
        robotapi.h
        base
            systems.h
        libcs
            adt.h
            cs.h
            csidcf.h
            getopt.h
            log.h
            pblock.h

The robot and its header files are written in ANSI C.

Header File Contents

This section describes the header files you can include when writing your plug-in functions. This section is intended as a starting point for learning the functions included in the header files.

Most of the header files are stored in the following directories:

PortalServer-base/sdk/robot/include

Contains header files that define general purpose data structures and function prototypes. Header files in this directory include:

csinfo.h

Contains functions for object typing, specifically for mapping files to MIME types.

csmem.h

Contains memory-related definitions.

robotapi.h

Contains the type definitions for structures and the return-code definitions for robot API functions.

filterrules.h

Contains type definitions for structures needed by filter rules.

PortalServer-base/sdk/robot/include/base

Contains the following header file to handle low-level, platform independent functions such as memory, file, and network access.

systems.h

Contains functions that handle system information.

PortalServer-base/sdk/robot/include/libcs

Contains header files of functions that handle robot and HTTP-specific functions such as handling access to configuration files and HTTP. The header files in this directory include:

adt.h

Contains type definitions and function prototypes for utilities needed by the robot, such as linked lists, queues, and hash tables.

cs.h

Contains a library of common functions used by the Search Engine.

csidcf.h

Contains configuration definitions for Search Engine.

getopt.h

Contains routines to get options from the command line, for example, command line prog -n arg1 -p arg2, to get arg1 and arg2.

log.h

Contains routines for writing information to log files.

pblock.h

Contains functions that manage parameter passing and robot internal variables. It also contains functions to get values from a user via the server.