DimDescriptionService::DimDescriptionService	(	const std::string &	name,
		const std::string &	desc
	)

Local storage for the applied description.

When the constructor is first called, a service with the name SERVER/SERVICE_DESC is created. The server name SERVER is retrieved from DimServer::itsName. If DimServer::itsName is empty, the server name is extracted from the given name as the part before the first '/'. A string "name=format\n" is added to fData and stored in fDescription.

A counter fCount for the number of instantiations is increased.

Parameters

name	The name of the service or command to be described, e.g. SERVER/COMMAND
desc	A description string. For details see class reference

Exceptions

If	a server name couldn't be reliably determined a logic_error exception is thrown; if the given description contains a ' ' also a logic_error is thrown.

Definition at line 71 of file DimDescriptionService.cc.

References fData, DimServer::itsName, Time::ms(), t, and Time::Time_t().

{
    string server = DimServer::itsName ? DimServer::itsName : "";
    if (server.empty())
    {
        const size_t p = name.find_first_of('/');
        if (p==string::npos)
            throw logic_error("Could not determine server name");

        server = name.substr(0, p);
    }

    if (desc.find_first_of('\n')!=string::npos)
            throw logic_error("Description for "+name+" contains '\\n'");

    if (!fService)
    {
        fService = new DimService((server+"/SERVICE_DESC").c_str(), const_cast<char*>(""));
        fData =
            server + "/SERVICE_DESC"
            "=Descriptions of services or commands and there arguments"
            "|Description[string]:For a detailed "
            "explanation of the descriptive string see the class reference "
            "of DimDescriptionService.\n" +
            server + "/CLIENT_LIST"
            "=Native Dim service: A list of all connected clients\n" +
            server + "/VERSION_NUMBER"
            "=Native Dim service: Version number of Dim in use"
            "|DimVer[int]:Version*100+Release (e.g. V19r17 = 1917)\n" +
            server + "/EXIT"
            "=This is a native Dim command: Exit program"
            "remotely. FACT++ programs use the given number as return code."
            "|Rc[int]:Return code, under normal circumstances this should be 0 or 1 (42 will call exit() directly, 0x42 will call abort() directly.\n" +
            server + "/SERVICE_LIST"
            "=Native Dim service: List of services, commands and formats"
            "|ServiceList[string]:For details see the Dim manual.\n";
    }


    fCount++;

    fDescription = name + '=' + desc;

    if (fData.find(fDescription+'\n')!=std::string::npos)
        return;

    fData += fDescription + '\n';

    const Time t;
    fService->setTimestamp(t.Time_t(), t.ms());
    fService->setData(const_cast<char*>(fData.c_str()));
    fService->updateService();
}

Here is the call graph for this function: