{
    "content": [
        {
            "type": "text",
            "text": "# Net::Jabber::Key (perldoc)\n\n## NAME\n\nNet::Jabber::Key - Jabber Key Library\n\n## SYNOPSIS\n\nNet::Jabber::Key is a module that provides a developer easy access\nto generating, caching, and comparing keys.\n\n## DESCRIPTION\n\nKey.pm is a helper module for the Net::Jabber::Transport.  When the\nTransport talks to a Client it sends a key and expects to get that\nkey back from the Client.  This module provides an API to generate,\ncache, and then compare the key send from the Client.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION** (1 subsections)\n- **METHODS** (1 subsections)\n- **AUTHOR**\n- **COPYRIGHT**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "Net::Jabber::Key",
        "section": "",
        "mode": "perldoc",
        "summary": "Net::Jabber::Key - Jabber Key Library",
        "synopsis": "Net::Jabber::Key is a module that provides a developer easy access\nto generating, caching, and comparing keys.",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 3,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 5,
                "subsections": [
                    {
                        "name": "Basic Functions",
                        "lines": 8
                    }
                ]
            },
            {
                "name": "METHODS",
                "lines": 1,
                "subsections": [
                    {
                        "name": "Basic Functions",
                        "lines": 19
                    }
                ]
            },
            {
                "name": "AUTHOR",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "COPYRIGHT",
                "lines": 3,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "Net::Jabber::Key - Jabber Key Library\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "Net::Jabber::Key is a module that provides a developer easy access\nto generating, caching, and comparing keys.\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "Key.pm is a helper module for the Net::Jabber::Transport.  When the\nTransport talks to a Client it sends a key and expects to get that\nkey back from the Client.  This module provides an API to generate,\ncache, and then compare the key send from the Client.\n",
                "subsections": [
                    {
                        "name": "Basic Functions",
                        "content": "$Key = new Net::Jabber::Key();\n\n$key = $Key->Generate();\n\n$key = $Key->Create(\"bob\\@jabber.org\");\n\n$test = $Key->Compare(\"bob\\@jabber.org\",\"some key\");\n"
                    }
                ]
            },
            "METHODS": {
                "content": "",
                "subsections": [
                    {
                        "name": "Basic Functions",
                        "content": "new(debug=>string,       - creates the Key object.  debug should\ndebugfh=>FileHandle,   be set to the path for the debug\ndebuglevel=>integer)   log to be written.  If set to \"stdout\"\nthen the debug will go there.  Also, you\ncan specify a filehandle that already\nexists and use that.  debuglevel controls\nthe amount of debug.  0 is none, 1 is\nnormal, 2 is all.\n\nGenerate() - returns a key in Digest SHA1 form based on the current\ntime and the PID.\n\nCreate(cacheString) - generates a key and caches it with the key\nof cacheString.  Create returns the key.\n\nCompare(cacheString, - compares the key stored in the cache under\nkeyString)     cacheString with the keyString.  Returns 1\nif they match, and 0 otherwise.\n"
                    }
                ]
            },
            "AUTHOR": {
                "content": "By Ryan Eatmon in May of 2000 for http://jabber.org.\n",
                "subsections": []
            },
            "COPYRIGHT": {
                "content": "This module is free software; you can redistribute it and/or modify it under the same terms as\nPerl itself.\n",
                "subsections": []
            }
        }
    }
}