Jon Portnoy > IRC-Indexer > IRC::Indexer::POD::NetworkSpec

Download:
IRC-Indexer-0.06.tar.gz

Annotate this POD

View/Report Bugs
Source  

NAME ^

IRC::Indexer::POD::NetworkSpec - Export format for a network

DESCRIPTION ^

This document describes the format of IRC::Indexer exports from a collection of trawlers composing an IRC network.

This is the data returned by IRC::Indexer::Report::Network after it has been fed at least one IRC::Indexer::Report::Server.

You'll probably want to read IRC::Indexer::POD::ServerSpec -- the same conventions apply.

HASH KEYS ^

  ConnectedAt => TIME
  FinishedAt  => TIME
  
  GlobalUsers => INT
  OperCount   => INT

  Servers     => HASH   (see below)
  LastServer  => STRING (last server trawled for this network)

  ChanCount   => INT  (public channels only)  
  HashChans   => HASH
  ListChans   => ARRAY

These are documented further in IRC::Indexer::POD::ServerSpec.

Servers hash

  Servers => {
    SERVER-NAME => {
      TrawledAt => TIME
      IRCD => STRING (server version)
      MOTD => [ ARRAY of MOTD lines ]  ## OPTIONAL
    }
  }

The Servers hash contains information pertaining to specific servers belonging to this network that have been trawled.

It is keyed on actual reported server name (the ServerName field of a Server export); each server is a nested hash.

AUTHOR ^

Jon Portnoy <avenj@cobaltirc.org>

http://www.cobaltirc.org

syntax highlighting: